-
Notifications
You must be signed in to change notification settings - Fork 31
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
"GOV.UK developer docs" is inconsistent naming and slightly exclusionary of non-developers #3002
Comments
Thanks for raising this @chao-xian. Have you evaluated what would need to change and what might break? I think we're lucky that the hostname shouldn't be affected by the change so links wouldn't break. I'm not sure if there are still references in puppet, I know there are references in govuk-docker. It'd also be helpful to have a proposal of what the new name should be - I'd suggest doing a quick demo branch in this repo that proposes and showcases the changes. I think the better our understanding of the effort/complications required and the fewer ambiguities of implementations the easier it is to move forward with a change. |
Agreed |
We now have Data Community docs included in the Dev Docs #3104 I haven't had time to do the checking of changes but will raise a PR |
We currently have our docs named
GOV.UK developer docs
while most other parts of GDS have their documentation named<blah> Technical Documentation
(even the middleman wrapping gem is calledtech-docs-gem
).We also groups of other technical folk across GOV.UK who could be contributing documentation. To make it a friendlier and more inclusive documentation site we should rename it to be more encompassing.
We must also be clearer on who the audience is. It's publicly available, but for internal consumption. The contributors and consumers are those who write code and add to the systems that are run by GOV.UK (mostly developers at the moment).
The text was updated successfully, but these errors were encountered: