You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Personally I would prefer a single point of documentation - XOR - make them synch, else this leads to confusion for users and other developers (e.g. what to update/change).
May I start an open discussion here, what the solution of the mis-match could look like?
I propose splitting documentation by audience, and have multiple places of documentation, like this:
for users of guac-visualization, provide a handbook like documentation on the docs.guac.sh web site
for administrators / devops, provide installation instructions in the repo (e.g. in the README.md or SETUP.md)
for other developers, provide implementation/debugging/test information in the repo (e.g. in a file DEVELOPMENT.md)
Also, each of the locations should be linked and guiding people, so they can understand the different pleases by their need (bookmark the right link ;) )
The text was updated successfully, but these errors were encountered:
Documentation that exists in two places is bound to be wrong eventually. :-) I like the idea of consolidating as much as we can. The approach I'd like to see is slightly different from what you propose. For this particular project, the user and administrator are likely going to be the same person, so I'd put your first two points in docs.guac.sh and the last in this repo. How does that sound?
Issue
I found the documentation in the repo docs/setup
and the documentation on https://docs.guac.sh/guac-visualizer/
are not in synch.
Proposal / discussion
Personally I would prefer a single point of documentation - XOR - make them synch, else this leads to confusion for users and other developers (e.g. what to update/change).
May I start an open discussion here, what the solution of the mis-match could look like?
I propose splitting documentation by audience, and have multiple places of documentation, like this:
Also, each of the locations should be linked and guiding people, so they can understand the different pleases by their need (bookmark the right link ;) )
The text was updated successfully, but these errors were encountered: