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

Fix some documentation links - links to md files require the `.md` extension #6126

Merged
merged 1 commit into from Apr 13, 2018

Conversation

Projects
None yet
3 participants
@adamsilverstein
Contributor

adamsilverstein commented Apr 11, 2018

@gziolo

This comment has been minimized.

Member

gziolo commented Apr 12, 2018

It’s more tricky change, because at the same time it will break links in Gutenberg handbook 🙁

That’s way all markdown files in docs folder are handbook first, in effect all urls are relative to navigation on .org website.

There are two ways we could fix it I can think of:

  • We put every single doc inside its own subfolder and name the file README.md.
  • Or better, we update handbook to be more flexible and strip .md when generating relative urls.

By the way, A similar issue exists when you provide code that uses ES5 and ES.next. It looks properly only in Gutenberg handbook.

@gziolo gziolo requested a review from pento Apr 12, 2018

@adamsilverstein

This comment has been minimized.

Contributor

adamsilverstein commented Apr 12, 2018

It’s more tricky change, because at the same time it will break links in Gutenberg handbook 🙁

@gziolo thanks for clarifying that, makes sense. yea - I was trying to navigate the md files directly on github which might not be uncommon so it would be nice if it could work.

How frequently is the handbook synced? I tend to use github to see the latest docs and can try to switch to handbook if they are kept in sync.

@gziolo

This comment has been minimized.

Member

gziolo commented Apr 12, 2018

How frequently is the handbook synced? I tend to use github to see the latest docs and can try to switch to handbook if they are kept in sync.

I think every 15 minutes. Gary knows best 😃

@gziolo gziolo merged commit a1b1422 into master Apr 13, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@gziolo gziolo deleted the fix/documentation-links branch Apr 13, 2018

@gziolo

This comment has been minimized.

Member

gziolo commented Apr 13, 2018

This is cool, thanks! We should update other links and move some of the doc files to subfolders to reflect handbook's URL structure. 💯

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment