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

Missing link to detailed PPD documentation #118

Merged

Conversation

jonrandahl
Copy link
Contributor

@jonrandahl jonrandahl commented Mar 12, 2024

Reconfigured the old ppd doc routes to redirect to app/doc/ppd as well as set the ppd_doc_path variable to point to the same reconfigured route; alongside adding tests querying the new route to ensure the route is valid and contains the expected content as well as tests to verify the old routes redirect with 302 temporary status as a safety measure.

Closes epimorphics/hmlr-linked-data#145

also includes permanent redirections for outdated variances of the ppd doc path value
first test verifies older link redirects permanently, second test verifies redirection also is permanent, third test ensures the link responds with success status (200), and fourth test ensures the page's opening content is what's expected
@jonrandahl jonrandahl self-assigned this Mar 12, 2024
Copy link
Member

@der der left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why the permanent redirect? All the others are temporary and that seems safer.

@jonrandahl
Copy link
Contributor Author

Why the permanent redirect? All the others are temporary and that seems safer.

Temporary redirections are best for when you plan to restore the original URL eventually, I didn't think we would be doing this in the application.

@jonrandahl jonrandahl requested a review from der March 12, 2024 17:30
@der
Copy link
Member

der commented Mar 12, 2024

Temporary redirections are best for when you plan to restore the original URL eventually, I didn't think we would be doing this in the application.

Restore or change. Once it's been published as permanent then all user browsers keep that indefinitely and you can never change it to anything else.

So if we ever wanted to change the app structure in the future we would have to work around that.

My mantra is never use a permanent redirect unless you are certain it will never change. E.g. http -> https, or moving from an obsoleted domain to a new domain. But I wouldn't normally use 301 within the structure of an app. Maybe I'm overcautious.

@jonrandahl
Copy link
Contributor Author

jonrandahl commented Mar 13, 2024

Thanks @der, I wasn't aware of the hassle to later change the links again. I've changed them all to 302's and adjusted the tests to reflect this. 🙏

@jonrandahl jonrandahl merged commit 23f1bed into dev-infrastructure Mar 13, 2024
2 checks passed
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