Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make Jekyll Routing Consistent #543

Merged
merged 1 commit into from
Sep 20, 2024
Merged

Make Jekyll Routing Consistent #543

merged 1 commit into from
Sep 20, 2024

Conversation

ajschmidt8
Copy link
Member

@ajschmidt8 ajschmidt8 commented Sep 20, 2024

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. Using permalink causes the generated HTML output to differ from pages that don't use it.

For example, when the api.md page uses permalink: api, the generated HTML output looks like this:

dist/
└── api.html

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, like resources/auto-merger.md:

dist/resources/
└── auto-merger
    └── index.html

The difference is that the output file is named index.html and placed in a directory called auto-merger. Webservers handle directories with index.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 new index.md name.

It also updates any references to the affected files.

@ajschmidt8 ajschmidt8 mentioned this pull request Sep 20, 2024
Copy link

netlify bot commented Sep 20, 2024

Deploy Preview for docs-rapids-ai ready!

Name Link
🔨 Latest commit 698c99a
🔍 Latest deploy log https://app.netlify.com/sites/docs-rapids-ai/deploys/66edb20f1de3970008809668
😎 Deploy Preview https://deploy-preview-543--docs-rapids-ai.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@ajschmidt8 ajschmidt8 marked this pull request as ready for review September 20, 2024 19:44
@ajschmidt8 ajschmidt8 requested a review from a team as a code owner September 20, 2024 19:44
@ajschmidt8 ajschmidt8 changed the title Fix Jekyll Routing Make Jekyll Routing Consistent Sep 20, 2024
@ajschmidt8 ajschmidt8 merged commit 4923321 into main Sep 20, 2024
7 checks passed
@ajschmidt8 ajschmidt8 deleted the fix-routing branch September 20, 2024 20:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants