Page MenuHomePhabricator

[mlir] fix broken link to Glossary
ClosedPublic

Authored by inouehrs on Tue, Jan 14, 5:17 AM.

Details

Summary

Glossary.md is missing in doc directory and links to Glossary.md are broken.
This patch copies Glossary.md from the old repository. It also touches up broken links to Glossary.md from the tutorial.

It looks like DeveloperGuide.md and TestingGuide.md have not been copied from the old repository too. Is it intentional?

Diff Detail

Event Timeline

inouehrs created this revision.Tue, Jan 14, 5:17 AM
ftynse requested changes to this revision.Tue, Jan 14, 7:34 AM
ftynse added a subscriber: ftynse.

It's in the website repo https://github.com/llvm/mlir-www/tree/master/website/content/getting_started and visible on mlir.llvm.org. Can you only fix the broken reference?

This revision now requires changes to proceed.Tue, Jan 14, 7:34 AM

Yes the missing docs are considered static and supposed to be in mlir-www and the links to them work on mlir.llvm.org via relative, but could be made explicit to the website here..

inouehrs updated this revision to Diff 237990.Tue, Jan 14, 8:28 AM

@ftynse @jpienaar I got it. Thank you so much for the clarification.
Instead of adding Glossary.md in the repo, broken links to Glossary.md are replaced with links to https://mlir.llvm.org/getting_started/Glossary/

I'd rather use relative links if you don't mind, it make it easier to work locally with a copy of the website.

Thanks for making this fix. +1 on using relative links. While you're here, you could also make the link to the glossary in the LangRef relative.

@lucyrfox @mehdi_amini The relative links may not work if someone reads the tutorial directly on github since now Tutorial and Glossary is in the different repos. Is it acceptable?

inouehrs retitled this revision from [mlir] copy missing Glossary.md from the old repository to [mlir] fix broken link to Glossary.Tue, Jan 14, 9:20 PM

The website uses a different layout anyway so many links won't work on GitHub, we don't expect them to. We prefer to be consistent and have the website working correctly.

inouehrs updated this revision to Diff 238235.Wed, Jan 15, 6:31 AM
  • make links to glossary in Tutorial and LangRef relative path.
ftynse accepted this revision.Wed, Jan 15, 6:44 AM
This revision is now accepted and ready to land.Wed, Jan 15, 6:44 AM
lucyrfox accepted this revision.Wed, Jan 15, 9:35 AM
This revision was automatically updated to reflect the committed changes.
Herald added a project: Restricted Project. · View Herald TranscriptWed, Jan 15, 9:19 PM