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

Tell users to use index instead of all when referring to sass imports #490

Merged
merged 1 commit into from
Nov 29, 2024

Conversation

owenatgov
Copy link
Contributor

What it says on the tin.

A companion PR to alphagov/govuk-frontend#5518. Once we merge both of these we can close alphagov/govuk-frontend#4988

Notes

There are numerous references to all in the v4 portion of our docs. We shouldn't update these since v4 doesn't replace all with index.

@owenatgov owenatgov requested a review from a team November 27, 2024 14:32
Copy link

netlify bot commented Nov 27, 2024

Deploy Preview for govuk-frontend-docs-preview ready!

Name Link
🔨 Latest commit d99f44f
🔍 Latest deploy log https://app.netlify.com/sites/govuk-frontend-docs-preview/deploys/67498ff67bf2b400088f77a3
😎 Deploy Preview https://deploy-preview-490--govuk-frontend-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Member

@romaricpascal romaricpascal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for raising the PR on the Frontend Docs 🙌🏻 Nothing major, just a little suggestion 😊 Doesn't change the tech side of things, so I'll approve.

```

You do not need `/index` at the end of your import if you’re using Dart Sass, LibSass 3.6.0 or higher, or Ruby Sass 3.6.0 or higher.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🙌🏻 Makes sense to be consistent with the rest of the site about this. I'll create an issue to remove statements about LibSass 3.6.0 and Ruby Sass 3.6.0 cross site.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wasn't sure about this one. We want to encourage folks to not use deprecated packages but also give folks the correct info if they are and aren't in a position to move off them. I feel like these docs lean more towards the latter.

source/installing-with-npm/index.html.md.erb Show resolved Hide resolved
…orts

Update source/installing-with-npm/index.html.md.erb

Co-Authored-By: Romaric Pascal <romaric.pascal@digital.cabinet-office.gov.uk>
@owenatgov owenatgov force-pushed the use-index-instead-of-all-for-sass-imports branch from f3e25d6 to d99f44f Compare November 29, 2024 09:57
@owenatgov owenatgov merged commit 95f9c82 into main Nov 29, 2024
5 checks passed
@owenatgov owenatgov deleted the use-index-instead-of-all-for-sass-imports branch November 29, 2024 11:43
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

Successfully merging this pull request may close these issues.

Deprecate remaining all.scss in favour of index.scss
2 participants