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.

Sign up for GitHub

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

Jump to bottom

Redirect Sass docs in review app to Sass API reference in Frontend Docs #1892

Closed
36degrees opened this issue Jul 31, 2020 · 4 comments · Fixed by #2706
Closed

Redirect Sass docs in review app to Sass API reference in Frontend Docs #1892

36degrees opened this issue Jul 31, 2020 · 4 comments · Fixed by #2706
Assignees
@EoinShaughnessy
Labels
documentation User requests new documentation or improvements to existing documentation tooling

Comments

@36degrees
Copy link
Contributor

36degrees commented Jul 31, 2020 •
edited
Loading

What

Redirect from http://govuk-frontend-review.herokuapp.com/docs to https://frontend.design-system.service.gov.uk/sass-api-reference/#sass-api-reference

We may need to provide a way to run the 'generic' Sass docs locally so that we can use it to preview documentation before we do a release.

Why

Avoid the confusion of having two versions of the Sass docs available, and point anyone who may have the existing docs bookmarked to the new docs.
@36degrees 36degrees added documentation User requests new documentation or improvements to existing documentation awaiting triage Needs triaging by team tooling labels Jul 31, 2020
@kellylee-gds kellylee-gds added 🕔 days and removed awaiting triage Needs triaging by team labels Aug 3, 2020
@EoinShaughnessy
Copy link
Contributor

EoinShaughnessy commented Sep 2, 2021 •
edited
Loading

@36degrees Our 'CSS Style Guide' doc contains a link to http://govuk-frontend-review.herokuapp.com/docs:

The syntax is used to generate a SassDoc application that documents SCSS in a readable format.

Should the link in the above quote go to https://frontend.design-system.service.gov.uk/sass-api-reference/#sass-api-reference instead?

@36degrees
Copy link
Contributor Author

@EoinShaughnessy yes, I think it probably should! Great catch. I don't think we should call it a 'SassDoc application' if we change the link though, and the wording could be clearer… maybe something like:

The SassDoc comments are used to generate the Sass API reference in the GOV.UK Frontend docs.

@36degrees
Copy link
Contributor Author

It's also odd that we link 'SassDoc' to the specific SassDoc documentation on file level annotations. That doesn't make sense to me – it should probably just link to the SassDoc homepage?

@EoinShaughnessy
Copy link
Contributor

@36degrees Thanks! That wording looks good. I'll raise a PR, separate to this issue, that includes both your wording and a link to the SassDoc homepage.

@EoinShaughnessy EoinShaughnessy self-assigned this May 24, 2022
@EoinShaughnessy EoinShaughnessy mentioned this issue May 24, 2022
Closed
36degrees added a commit that referenced this issue Jul 19, 2022
@36degrees
Redirect Sass docs when running on Heroku
8a33b26 
When running on Heroku (based on the presence of the `HEROKU_APP` environment variable set in `app.json`):

- link to the live API reference docs from the homepage of the review app
- redirect requests for `/docs` to the live API reference docs

This avoids the confusion of having two ‘live’ versions of the Sass docs available, whilst redirecting anyone who may have the existing docs bookmarked.

However, it’s still useful to be able to run the 'generic' Sass docs locally so that we can use it to preview documentation before we do a release. As such, when running locally:

- link to both the live API reference docs and the ‘local’ docs from the homepage of the review app
- preserve the existing behaviour of serving the locally generate Sass docs when visiting `/docs`

Closes #1892.
36degrees added a commit that referenced this issue Jul 19, 2022
@36degrees
Redirect Sass docs when running on Heroku
8649332 
When running on Heroku (based on the presence of the `HEROKU_APP` environment variable set in `app.json`):

- link to the live API reference docs from the homepage of the review app
- redirect requests for `/docs` to the live API reference docs

This avoids the confusion of having two ‘live’ versions of the Sass docs available, whilst redirecting anyone who may have the existing docs bookmarked.

However, it’s still useful to be able to run the 'generic' Sass docs locally so that we can use it to preview documentation before we do a release. As such, when running locally:

- link to both the live API reference docs and the ‘local’ docs from the homepage of the review app
- preserve the existing behaviour of serving the locally generate Sass docs when visiting `/docs`

Closes #1892.
@36degrees 36degrees mentioned this issue Jul 19, 2022
Merged
@36degrees 36degrees linked a pull request Jul 19, 2022 that will close this issue
Redirect Sass docs when running on Heroku #2706
Merged
querkmachine pushed a commit that referenced this issue Jul 26, 2022
@36degrees @querkmachine
Redirect Sass docs when running on Heroku
50023ed 
When running on Heroku (based on the presence of the `HEROKU_APP` environment variable set in `app.json`):

- link to the live API reference docs from the homepage of the review app
- redirect requests for `/docs` to the live API reference docs

This avoids the confusion of having two ‘live’ versions of the Sass docs available, whilst redirecting anyone who may have the existing docs bookmarked.

However, it’s still useful to be able to run the 'generic' Sass docs locally so that we can use it to preview documentation before we do a release. As such, when running locally:

- link to both the live API reference docs and the ‘local’ docs from the homepage of the review app
- preserve the existing behaviour of serving the locally generate Sass docs when visiting `/docs`

Closes #1892.
querkmachine pushed a commit that referenced this issue Oct 17, 2022
@36degrees @querkmachine
Redirect Sass docs when running on Heroku
9d0db07 
When running on Heroku (based on the presence of the `HEROKU_APP` environment variable set in `app.json`):

- link to the live API reference docs from the homepage of the review app
- redirect requests for `/docs` to the live API reference docs

This avoids the confusion of having two ‘live’ versions of the Sass docs available, whilst redirecting anyone who may have the existing docs bookmarked.

However, it’s still useful to be able to run the 'generic' Sass docs locally so that we can use it to preview documentation before we do a release. As such, when running locally:

- link to both the live API reference docs and the ‘local’ docs from the homepage of the review app
- preserve the existing behaviour of serving the locally generate Sass docs when visiting `/docs`

Closes #1892.
@colinrotherham colinrotherham mentioned this issue May 26, 2023
Open
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@EoinShaughnessy EoinShaughnessy

Labels
documentation User requests new documentation or improvements to existing documentation tooling
Projects
GOV.UK Design System cycle board
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Redirect Sass docs when running on Heroku alphagov/govuk-frontend
3 participants
@36degrees @kellylee-gds @EoinShaughnessy