ProjectPythia / projectpythia.github.io

https://projectpythia.org
Apache License 2.0
32 stars 18 forks source link

Should the links from our navigation bar be relative? #263

Open clyne opened 2 years ago

clyne commented 2 years ago

Many (all) of the links from our top level navigation bar menu items, such as the one under Community below, are full URLs (not relative links). Hence previewing locally as described in our contributors guide here is not possible: the link takes you to the production site.

https://github.com/ProjectPythia/projectpythia.github.io/blob/57407bfc5c38208f3a85d9a3ef8d80a4657ea4fb/portal/conf.py#L103

kmpaul commented 2 years ago

That's by design. There are other links further down in the page that are relative that will take you to the locally hosted site.

clyne commented 2 years ago

That indeed works. Thanks. However, I'm not sure what to do about the confusion our contributor's guide will cause. Any thoughts @kmpaul ?

kmpaul commented 2 years ago

I think we should just include a warning that (1) any external links from the locally built site (or in the preview) will take you away from the preview and (2) any internal links in the top menubar will take you away from the preview, too.

kmpaul commented 2 years ago

It might be possible to make the internal links in the top-bar relative. I'll have to look into that.

clyne commented 2 years ago

Thanks. I don't think it is high priority because it is mostly the Pythia team that touches the landing pages.

jukent commented 1 year ago

Having them be absolute links helps with consistency across the sites, I think. The low hanging fruit would be to add the warning to the contributor's guide.