search

CouncilDataProject / cdptools_v2

Tools you can use to interact with and run Council Data Project instances.
Other
7 stars 9 forks source link

Update Index links for "Backend Design" in documentation #113

Closed aminamos closed 4 years ago

aminamos commented 4 years ago

Description

A clear description of the bug Technically "Transcript Format" and "Deploying and Running CDP Pipelines" have the same issue, but clicking an item in the index list doesn't bring the user to that section on the page.

Expected Behavior

What did you expect to happen instead? Brought to Pipelines section, actual link is https://councildataproject.github.io/cdptools/system_design.html#id9

system_design.md has the correct link, maybe something is up with system_design.rst? I do not have experience with these tools, and am new to this overall.

Reproduction

A minimal example that exhibits the behavior.

  1. Navigate to https://councildataproject.github.io/cdptools/system_design.html
  2. Click "Pipelines" in the index
  3. URL in address bar changes to https://councildataproject.github.io/cdptools/system_design.html#pipelines
  4. Position on the page stays the same

Environment

Any additional information about your environment

evamaxfield commented 4 years ago

Yea I have been frustrated by this as well. I'm 90% sure it has something to do with Sphinx doc generation. Most of the links should work properly unless there is a typo in the ref or something. For example, if you hover of the item in the tree on the left side the actual ref is there, usually it is like #id2 or similar. This is Sphinx generated and I am not sure why they are replacing the value.