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

[As part of release] Updates the docs to point to the right files #1466

Merged
merged 1 commit into from
Jul 29, 2019

Conversation

aliuk2012
Copy link
Contributor

@aliuk2012 aliuk2012 commented Jun 19, 2019

As part of namespacing, we need to update the links the docs point to
so that they are still valid and do not break.

@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-review-pr-1466 June 19, 2019 14:52 Inactive
@aliuk2012 aliuk2012 changed the base branch from master to al/namespace June 20, 2019 10:32
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-review-pr-1466 June 20, 2019 10:34 Inactive
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-review-pr-1466 June 21, 2019 09:56 Inactive
@aliuk2012 aliuk2012 changed the base branch from al/namespace to master June 21, 2019 09:57
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-review-pr-1466 June 26, 2019 13:26 Inactive
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-review-pr-1466 June 26, 2019 13:32 Inactive
@36degrees 36degrees modified the milestones: Next, v3.0.0 Jul 10, 2019
Copy link
Contributor

@36degrees 36degrees left a comment

Choose a reason for hiding this comment

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

Generally looks like a sane set of changes 👍

I've got one question about importing JavaScript components…

docs/installation/installing-with-npm.md Outdated Show resolved Hide resolved
@NickColley
Copy link
Contributor

Unless we change the default branch to a v2.X tag merging this would make the installation docs incorrect until we do the v3.0.0 release so I've put a blocked label on this.

@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-review-pr-1466 July 12, 2019 09:22 Inactive
@aliuk2012
Copy link
Contributor Author

I've addressed @36degrees comment on not having two options to import js. Hopefully this is now in a state to be ready to merge once we do a v3 release

Copy link
Contributor

@m-green m-green left a comment

Choose a reason for hiding this comment

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

Looks good to me! Just one comment.

@@ -20,8 +20,6 @@ Components must:

Component folder and files should be singular, except in cases where they are more commonly used in groups, for example, radios, breadcrumbs and checkboxes.

An example component exists in `src/components/component-example`.

Use this as the basis for creating new components.
Copy link
Contributor

@m-green m-green Jul 12, 2019

Choose a reason for hiding this comment

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

Should the "Use this as the basis..." line be removed as well? 'This' seems to refer to the example component that we've now removed reference to.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yep, I'll update this now.

Great spot 👀

@NickColley NickColley changed the title Updates the docs to point to the right files [As part of release] Updates the docs to point to the right files Jul 23, 2019
As part of namespacing, we need to update the links the docs point to
so that they are still valid and do not break. We also needed to update
the examples to show how to use the new namespace.
@36degrees 36degrees merged commit 0f0f3a4 into master Jul 29, 2019
@36degrees 36degrees deleted the al/namespacing-doc-update branch July 31, 2019 15:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

5 participants