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

Setup URL forwarding with plain HTML files #46

Merged
merged 1 commit into from
Dec 14, 2021
Merged

Setup URL forwarding with plain HTML files #46

merged 1 commit into from
Dec 14, 2021

Conversation

leouieda
Copy link
Member

We were using subdomain forwarding (calendar.fatiando.org) for some hard
to remember URLs. This unfortunately doesn't work with HTTPS, leading to
some broken links and ugly warnings from browsers about potential
danger. Replace those with a simple HTML redirection structure in
subfolders. For example, fatiando.org/calendar now redirects to the
Google calendar link. Same for fatiando.org/slack and
fatiando.org/good-first-issue. There are instructions in the README
for adding new forwards.
A caveat is that we now have to be careful with the subfolders we create
here. But that's probably not going to be a problem since this website
is intentionally not very elaborate (it links to other resources).

Reminders:

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst and the base __init__.py file for the package.
  • Write detailed docstrings for all functions/classes/methods. It often helps to design better code if you write the docstrings first.
  • If adding new functionality, add an example to the docstring, gallery, and/or tutorials.
  • Add your full name, affiliation, and ORCID (optional) to the AUTHORS.md file (if you haven't already) in case you'd like to be listed as an author on the Zenodo archive of the next release.

We were using subdomain forwarding (calendar.fatiando.org) for some hard
to remember URLs. This unfortunately doesn't work with HTTPS, leading to
some broken links and ugly warnings from browsers about potential
danger. Replace those with a simple HTML redirection structure in
subfolders. For example, `fatiando.org/calendar` now redirects to the
Google calendar link. Same for `fatiando.org/slack` and
`fatiando.org/good-first-issue`. There are instructions in the README
for adding new forwards.
A caveat is that we now have to be careful with the subfolders we create
here. But that's probably not going to be a problem since this website
is intentionally not very elaborate (it links to other resources).
@leouieda leouieda merged commit 4c4e681 into main Dec 14, 2021
@leouieda leouieda deleted the forward branch December 14, 2021 10:54
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