Has anyone been working with solutions coming dire...
# documentation
m
Has anyone been working with solutions coming directly from the codebase / code repo? I 've never found a streamlined manner to achieve it. I mean, we have a bunch of things that help (swagger / open API for APIs, class and method annotations that can be transformed, mermaid docs can be displayed on the repo site), but they tend to be published to different places that are "hard" to find (depending on what roles and habits you have). And then there's licensing issues that lead to having everything published to confluence, but it's pretty much always a manual procedure (so duplication of effort)... Wondering if backstage would support a lot of this (I haven't tried it yet)
s
I think this is very similar to my talk at platformcon! If you want some of the information we wrote a blog article on some of it. Hope it helps https://achievers.engineering/documentation-part-2-still-running-through-the-6-with-documentation-woes-ce84d6bbc5ea?source=collection_home---4------5-----------------------
πŸ‘ 1
Oh and our solution was β€œfree”/ opensource
m
yeah
looks like the same pain points I was running into
especially connecting / updating confluence
πŸ‘ 2
I've found the doc update with code review flow to be real good and timely; The problem was not being able to automatically get the changes into Confluence where other stakeholders "live" in
s
Yes that was one of our issues too. If your GitHub is private I think you can allow everyone to see it. But if it's private then no
πŸ’― 1
We also thought about hosting in a bucket or in a container which everyone can access
It's hard to change that mindset and workflow of others though who use confluence