-
Notifications
You must be signed in to change notification settings - Fork 38
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
Add signposting after moving docs
folder content
#151
Conversation
docs
folder content
Just to check my understanding, does that mean we're moving the documentation out of this repo, but at some point in the future we plan to bring it back? |
docs/configuration.md
Outdated
See the separate [documentation for page expiry][expiry] for more details. | ||
|
||
[expiry]: https://tdt-documentation.london.cloudapps.digital/page-expiry.html#page-expiry-and-review | ||
Content has been moved to alphagov/tdt-documentation: https://github.com/alphagov/tdt-documentation/pull/108/commits/e50c6bc0dd43b2f299444b7dc760e1a85edcb718 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would it be more useful to link the user to the live documentation site for these links (e.g. https://tdt-documentation.london.cloudapps.digital/amend_project/configuration/#configuration-options)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My reasoning for putting that link in was to explain why it was moved. But I think you're right, it's probably more helpful to tell users where the content was moved to.
How about changing it to something like:
This content has been moved to: https://tdt-documentation.london.cloudapps.digital/amend_project/configuration/#configuration-options
Do you think it's worth linking to the source file too?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added links to where the content is published: 2441420
The pages have links to the alphagov/tdt-documentation
repo as well as the contribution banner so it should be fairly straightforward to find the source.
@36degrees yup, that's been the plan for a while now (#83) but it's harder to find the time to do it. I went for the moving back and forth approach to allow progress in smaller chunks of work, rather than snowballing the migration work. |
Following advice from #151 (comment)
What
There's a PR to move the content from
docs
folder toalphagov/tdt-documentation
: alphagov/tdt-documentation#108The move is to make it easier to work on improving the documentation. Raising PRs for changes across 2 repos is annoying. The long-term plan is to move the docs to the gem itself, but we need to work out some technicalities first.
This PR is to:
docs
folder if Fix all broken links and add link checker tdt-documentation#108 is mergeddocs
folder went.Why
This PR aims to avoid content duplication and to not confuse contributors to the tech-docs gem.
The CONTRIBUTING.md file talks about updating content in the
docs
folder so we should update this to the new location for documentation. We should also say where the content ofdocs
went.How to review
Check that signposting is sensible.
Only merge if alphagov/tdt-documentation#108 is merged.