Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
NOTE: These changes are necessary for #541.
TL;DR
This PR fixes some inconsistencies with how the HTML output is generated for various pages on the docs site.
Detailed Explanation
This PR fixes some routing issues with our site. The issue stems from using the
permalink
property on certain pages. Usingpermalink
causes the generated HTML output to differ from pages that don't use it.For example, when the
api.md
page usespermalink: api
, the generated HTML output looks like this:This causes the final webpage to be available at https://docs.rapids.ai/api (note the missing trailing slash at the end of the URL).
Compare that to the HTML output of pages that don't use the
permalink
property, likeresources/auto-merger.md
:The difference is that the output file is named
index.html
and placed in a directory calledauto-merger
. Webservers handle directories withindex.html
differently. Therefore, the above page is served at https://docs.rapids.ai/resources/auto-merger/ (note the trailing slash at the end of the URL).To make all of our paths consistent (which is necessary for #541), this PR removes all
permalink
property usage and moves the affected files to the appropriate directory with a newindex.md
name.It also updates any references to the affected files.