search

metanorma / metanorma.org

Official Metanorma website
https://www.metanorma.org
MIT License
7 stars 7 forks source link

Installation guide leads to broken link #182

Open ronaldtse opened 4 years ago

ronaldtse commented 4 years ago

From a new user:

I'm trying to find the steps for manual installation of Metanorma. They're supposed to be at https://www.metanorma.com/software/metanorma-cli/docs/installation/, but I get a 404 for that page. https://www.metanorma.com/author/topics/install/ has the incorrect link on it.

Ping @strogonoff @opoudjis

opoudjis commented 4 years ago

This is clearly an intended refactoring, porting content from Github to the software/ subdirectory of metanorma, which has never happened. There are 11 such instances in metanorma.com:

author/topics/install.adoc:Refer to link:/software/metanorma-cli/docs/installation/[Metanorma CLI installation docs] author/topics/install.adoc:This uses Metanorma’s link:/software/homebrew-metanorma[Homebrew formula]. author/topics/install.adoc:See link:/software/metanorma-cli/[Metanorma CLI docs] flavor-quickstart-steps.adoc:link:/software/{{ include.flavor.implemented_by }}[{{ include.flavor.implemented_by }}]. flavor-quickstart-steps.adoc:* link:/software/{{ include.flavor.implemented_by }}/[Ruby gem “{{ include.flavor.implemented_by }}”] flavor-quickstart-steps.adoc: building on top of link:/software/metanorma/[core Metanorma library]. _samples/draft-camelot-holy-grenade.adoc:documents, link:/software/metanorma-ietf/[metanorma-ietf]. author/csd.adoc:make sure to read link:/software/metanorma-cli/docs/installation/[installation notes]. author/ogc.adoc:make sure to read link:/software/metanorma-cli/docs/installation/[installation notes]. author/unece.adoc:make sure to read link:/software/metanorma-cli/docs/installation/[installation notes]. author/topics/install.adoc:Refer to link:/software/metanorma-cli/docs/installation/[Metanorma CLI installation docs] author/topics/install.adoc:This uses Metanorma’s link:/software/homebrew-metanorma[Homebrew formula]. author/topics/install.adoc:See link:/software/metanorma-cli/[Metanorma CLI docs] author/topics/document-format/diagrams.adoc:make sure to read link:/software/metanorma-cli/docs/installation/[installation notes].

I will not fix these, these are clearly a matter for metanorma.com design, which is incomplete. The broken link is meant to be https://github.com/metanorma/metanorma-cli/blob/master/docs/installation.adoc , but the fix needs to be systematic.