search

informatics-isi-edu / deriva-docs

Top-level documentation for DERIVA software
0 stars 0 forks source link

broken anchor in chaise + two installation docs #11

Closed crisaless closed 5 years ago

crisaless commented 5 years ago

I found another instance of github and sphinx processing anchors differently – so the current linking below works on github.com but doesn’t on the docs site – which is probably fine for now until we find a way to fix it:

chaise/docs/user-docs/installation.md

links to 

chaise/docs/dev-docs/e2e-test.md#how-to-get-your-auth_cookie

but sphinx doesn’t use the underscore and turns it into a hyphen: #how-to-get-your-auth-cookie

It’s probably more important that this work on github than on the user docs site – so I think we can leave this for now.

I also noticed there’s two installation docs:

chaise/docs/install.md
chaise/docs/user-docs/installation.md

Can you take a look and let me know if these two files are needed?

RFSH commented 5 years ago

The first one (chaise/docs/install.md) should be removed.

I can change the title to mitigate that issue with the url, should I do it? Is that the only place that we have this problem?

crisaless commented 5 years ago

I'll just remove the file, thanks!

As for the anchor/title issue - I'll go ahead and change it. So far I've haven't found any other instances of this kind of problem but will let you know when I do.

crisaless commented 5 years ago

Fixed