search

mulesoft / docs-general

BSD 3-Clause "New" or "Revised" License
11 stars 51 forks source link

adding glossary back #19

Closed Mulesoft-Mysti closed 5 years ago

Mulesoft-Mysti commented 5 years ago

Adding a glossary: Will & Fer, when I tested this locally, the glossary.html was created and looked correct on my local machine, and the left nav showed the link for glossary, but when I clicked the link in my local build, I got the Page Not Found error. Could you look at this and see if I've done something wrong?

Mulesoft-Mysti commented 5 years ago

image image

glossary.html.zip

build-all.yml.zip

Mulesoft-Mysti commented 5 years ago

My build command: antora --clean build-all.yml

wwarner-salesforce commented 5 years ago

I built using the attached .yml file and the Glossary worked OK for me with no Page Not Found errors. I used these commands:

antora build.yml open build/site/index.html

I wonder if this might be some quirk related to using "serve" instead of "open". If you use "open" to view the files, do all the links work OK on your machine?

(The icons in the left menu will appear as broken images when using "open", but this is safe to ignore.)

build.yml.txt

wwarner-salesforce commented 5 years ago

Sorry, forgot to explain: I changed your .yml file only by making the paths correct for my local setup.

wwarner-salesforce commented 5 years ago

OK, I am now able to reproduce this.

You saw the Page Not Found error for the URL localhost:5000/getting-started/glossary . Indeed, that is a bad URL. The correct URL is localhost:5000/general/getting-started/glossary .

When I use the "serve" command and open http://localhost:5000/general , all the links to other files in that node are bad links, such as http://localhost:5000/getting-started/check-published-api-specs and http://localhost:5000/getting-started/glossary . Links to files in other nodes are OK.

Workaround: Use the left menu to go to a file in another node. Then use the left menu to go to the glossary.

This is inconvenient, and I wish I knew how to prevent the problem, but at least we have a workaround.

Using "open" instead of "serve" also seems to work around this error.

wwarner-salesforce commented 5 years ago

I added this to the Troubleshooting section of the Local Builds file. https://docs.google.com/document/d/1TzGgG4OuK5fjEBu4wCRs-Pu6zt0jRLc7EQozG52JaPM/