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

Governance docs have multiple sources of truth #245

Open
GuySartorelli opened this issue Aug 3, 2022 · 0 comments
Open

Governance docs have multiple sources of truth #245

GuySartorelli opened this issue Aug 3, 2022 · 0 comments

Comments

@GuySartorelli
Copy link
Member

GuySartorelli commented Aug 3, 2022

The governance documentation can be (and is) different between the different versions of docs (i.e. CMS3 vs CMS4 docs). This leads to conflicting information depending on where you look. This will continue to be a problem even if we removed documentation for EOL versions, because we're unlikely to update governance docs on any branch other than the most recent stable.

Options

  1. Create a "governance docs" repository to hold the source for governance docs (contributing, maintenance guidelines, processes, etc)
    • We can then use the new repository for governance docs and the dev docs for everything else - this would be similar to how the userhelp docs pull from multiple repos.
  2. Keep "governance docs" where they are, but only show the current stable version on docs.silverstripe.org
  3. Host the governance docs entirely separately from docs.silverstripe.org

Notes

  • With both options 1 and 2 above, we'll need some UX advice for how to indicate that this documentation isn't tied to CMS versions the same way the developer docs are (or if such an indication is even necessary).
    • It may be as simple as not displaying the version note at the top of the page, possibly in combination with hiding the version picker.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant