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

Docs: Add link to JavaScript Build Step to TOC #18707

Merged
merged 1 commit into from Nov 24, 2019
Merged

Docs: Add link to JavaScript Build Step to TOC #18707

merged 1 commit into from Nov 24, 2019

Conversation

@mkaz
Copy link
Member

mkaz commented Nov 23, 2019

Description

Updates the Table of Contents for JavaScript tutorial.

  1. Adds link to JavaScript Build Step page, missed when page was added.

  2. Updates links to be relative, shorter and easier to code. Previously the docs required all links to start from /docs There was an update at some point that supports relative links in same directory.

How has this been tested?

Verify documentation and links, view on branch here.

Types of changes

Documentation.

Copy link
Member

chrisvanpatten left a comment

Looks good to me! Just to be sure, this will definitely work with the sync into the handbook? I assume you wouldn't have made the change if you weren't confident it would work, but, y'know… figured I'd ask :)

@chrisvanpatten

This comment has been minimized.

Copy link
Member

chrisvanpatten commented Nov 23, 2019

As a side note, is there possibly a way we could have PRs that only consist of changes in *.md files excluded from Travis builds? Is it worth it?

Seems to me like (a) it's a waste of resources to run a full test suite for changes that only impact docs, and (b) it means we can't merge (without admin overrides) for these changes.

(Am I missing any potential pitfalls?)

@mkaz

This comment has been minimized.

Copy link
Member Author

mkaz commented Nov 24, 2019

My confidence for if it works is that it works fine for this file, that links to a file in teh same directory. So assumes it will for these changes. If I can ever get to Green, I'll merge and wait and confirm the links. https://github.com/WordPress/gutenberg/blame/master/docs/designers-developers/developers/tutorials/javascript/js-build-setup.md#L122

And yes, I'm onboard for any improvements to get tests to pass more reliably, or not needed for docs changes would be welcome :-)

@gziolo

This comment has been minimized.

Copy link
Member

gziolo commented Nov 24, 2019

Seems to me like (a) it's a waste of resources to run a full test suite for changes that only impact docs, and (b) it means we can't merge (without admin overrides) for these changes.

We had that before but I no longer remember why we decided to enable full check again.

I have concerns in regards whether those updates for paths will work outside of GitHub. You can give it a try and see. I think we settled on paths relative to the top of the repository to make it easier to replace with URLs when rendering handbook pages.

@mkaz mkaz merged commit 17a13cc into master Nov 24, 2019
2 checks passed
2 checks passed
pull-request-automation
Details
Travis CI - Pull Request Build Passed
Details
@mkaz mkaz deleted the docs/toc-js branch Nov 24, 2019
@youknowriad youknowriad added this to the Gutenberg 7.0 milestone Nov 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.