Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation in repo and web site not in synch #113

Open
nitram509 opened this issue Oct 13, 2024 · 1 comment
Open

Documentation in repo and web site not in synch #113

nitram509 opened this issue Oct 13, 2024 · 1 comment

Comments

@nitram509
Copy link
Contributor

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:

  • 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 ;) )

@funnelfiasco
Copy link
Collaborator

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants