4 ms·
> With well set up CI and automated builds, would you need this documentation at all? We have that. But how would you know that we have that without documentat
by dalemyers 9y ago
> With well set up CI and automated builds, would you need this documentation at all?
We have that. But how would you know that we have that without documentation telling you? How would you know where to find the resulting builds or to check the status?
- timlloyd 9y agoFair enough. We currently document such systems details in Confluence, which I can't recommend for all the reasons given by others here. > We could have the documentation in a separate repository, but if we are going to be making this leap, we want to be sure we are using the right tools for the jobs. If you haven't considered this yet, it would be very easy to set up a Mkdocs[1] site for testing, using all of your existing documentation. Should be as simple as making a new site and dragging your current docs folder contents into the docs dir. It has good search built in with Lunr[2]. Try the Material theme[3] if looks are important. [1] http://www.mkdocs.org http://www.mkdocs.org [2] https://lunrjs.com https://lunrjs.com [3] https://squidfunk.github.io/mkdocs-material/ https://squidfunk.github.io/mkdocs-material/