Skip to content

docs: add homepage link#10418

Merged
nicolo-ribaudo merged 3 commits intobabel:masterfrom
danieleloscozzese:patch-1
Oct 17, 2019
Merged

docs: add homepage link#10418
nicolo-ribaudo merged 3 commits intobabel:masterfrom
danieleloscozzese:patch-1

Conversation

@danieleloscozzese
Copy link
Copy Markdown
Contributor

@danieleloscozzese danieleloscozzese commented Sep 9, 2019

Q                       A
Fixed Issues? No issue raised that I can see.
Patch: Bug Fix? I haven't incremented the version because there is no functional change.
Major: Breaking Change? No.
Minor: New Feature? No.
Tests Added + Pass? There are no tests in the package. I ran the global tests and none of the reported errors were in this package.
Documentation PR Link This is the documentation change.
Any Dependency Changes? No.
License MIT

Adds a homepage link to populate npmjs.com from the package.json so that a link is available there in the sidebar. This link is exactly the one taken from README.md.

Update the repository property syntax to the object syntax including type: "git".

@danieleloscozzese
docs: add homepage link
1761c96 
Adds a homepage link to populate npmjs.com.
Update the repository property syntax.
@babel-bot
Copy link
Copy Markdown
Collaborator

babel-bot commented Sep 9, 2019 •
edited
Loading

Build successful! You can test your changes in the REPL here: https://babeljs.io/repl/build/11535/

JLHwung
JLHwung reviewed Sep 9, 2019
View reviewed changes
@JLHwung
Copy link
Copy Markdown
Contributor

JLHwung commented Sep 9, 2019 •
edited
Loading

npm docs will respect the homepage field, I think it is a good idea to align homepage to the README in all the sub packages.

@JLHwung JLHwung added the PR: Internal 🏠 A type of pull request used for our changelog categories label Sep 9, 2019
@danieleloscozzese
Update the repository link
166049e 
Point to the root repo plus a reference to the subdirectory.
@danieleloscozzese
Copy link
Copy Markdown
Contributor Author

danieleloscozzese commented Sep 10, 2019

Hi there @JLHwung, I'm not sure of what you meant by your review comment

… I think it is a good idea to align homepage to the README in all the sub packages.

Do you mean that I should link directly to the README in the homepage link, or that the homepage of the other submodules should also point directly to their documentation pages?

I can make either change, but I did think that as a consumer it would be useful to have a link directly to the intended location rather than replicate the link from the README.
However the npmjs.com sidebar UI would be populated as long as something is added, and that was my intention.

JLHwung
JLHwung reviewed Sep 17, 2019
View reviewed changes
@nicolo-ribaudo nicolo-ribaudo merged commit b5b8055 into babel:master Oct 17, 2019
@nicolo-ribaudo
Copy link
Copy Markdown
Member

nicolo-ribaudo commented Oct 17, 2019

@DanArthurGallagher It would be really useful is the "homepage" link pointing to the correct page on the website is added to all the packages which have a docs page!

@snyk-bot snyk-bot mentioned this pull request Nov 14, 2019
Merged
This was referenced Nov 28, 2019
Open
Open
This was referenced Dec 5, 2019
Open
Merged
@snyk-bot snyk-bot mentioned this pull request Jan 12, 2020
Open
@lock lock bot added the outdated A closed issue/PR that is archived due to age. Recommended to make a new issue label Jan 16, 2020
@lock lock bot locked as resolved and limited conversation to collaborators Jan 16, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@JLHwung JLHwung JLHwung approved these changes

Assignees

No one assigned

Labels

outdated A closed issue/PR that is archived due to age. Recommended to make a new issue PR: Internal 🏠 A type of pull request used for our changelog categories

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@danieleloscozzese @babel-bot @JLHwung @nicolo-ribaudo