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

Fix Jekyll Routing #542

Closed
wants to merge 1 commit into from
Closed

Conversation

ajschmidt8
Copy link
Member

NOTE: These changes are necessary for #541. They are included in that PR. This PR is not meant to be merged, it only exists so that these individual changes can be viewed separately from #541.

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.

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/66edafce584dd6000802e694
😎 Deploy Preview https://deploy-preview-542--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 closed this Sep 20, 2024
@ajschmidt8
Copy link
Member Author

superseded by #543

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.

1 participant