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

Design part of our website has two different pages #2529

Open
kannon92 opened this issue Jun 1, 2023 · 10 comments
Open

Design part of our website has two different pages #2529

kannon92 opened this issue Jun 1, 2023 · 10 comments
Assignees
Labels
bug Something isn't working component/contribex Contribution Experience good first issue Good for newcomers type/documentation Improvements or additions to documentation

Comments

@kannon92
Copy link
Contributor

kannon92 commented Jun 1, 2023

Describe the bug

If you browse to https://armadaproject.io/design/ you can see the relationships doc that @Sharpz7 added.

But if you click design via website (https://armadaproject.io/design), it will not have the relationships doc.

Files Or Markdown that can reproduce the issue

Expected behavior
I would expect that we should have https://armadaproject.io/design/ behavior in both cases.

┆Issue is synchronized with this Jira Task by Unito

@dave-gantenbein dave-gantenbein added the good first issue Good for newcomers label Jun 1, 2023
@JosephHuntley
Copy link

I have identified the issue as file routing. When accessing the URL https://armadaproject.io/design, it fetches design.md, whereas https://armadaproject.io/design/ fetches design/index.md. This discrepancy occurs because the browser interprets the trailing slash in the URL as the 'index' page.

An optimal solution would be to set up a redirect from https://armadaproject.io/design to https://armadaproject.io/design/ and remove design.md since this wouldn't break any links relying on https://armadaproject.io/design while also creating only a single file to update whenever changes occur. A sub-optimal fix would be to update design.md. However, this would lead to both files needing to be maintained whenever an update occurs.

As this is my first contribution to the project, I'm unsure about the underlying technology that controls routing. I would appreciate guidance on how to implement a fix to address this file routing issue.

Thank you for your assistance.

@dave-gantenbein
Copy link
Member

Hi @JosephHuntley! The underlying technology is Github pages, and they are served from their own branch: gh-pages.

Hope that helps.

@ShivangShandilya
Copy link
Contributor

@JosephHuntley are you working on this issue? If not, I would like to work on it.

@JosephHuntley
Copy link

@ShivangShandilya My apologies, yes feel free. I'm unsure how to fix the issue without using JS to redirect the page.

@kirtanchandak
Copy link

Hey if anyone is not workin on this issue can I take this @kannon92, assign it to me!

@arssshhhk
Copy link

@ShivangShandilya are you working on this issue? if not, I would like to work on it.

@ShivangShandilya
Copy link
Contributor

Yup mate I'll be done with this soon, been busy with my GSoC project. If I'm not able to do this I'll surely pass on this to you

@Sharpz7
Copy link
Contributor

Sharpz7 commented Aug 15, 2023

@ShivangShandilya Any update?

@ShivangShandilya
Copy link
Contributor

ShivangShandilya commented Aug 17, 2023

@ShivangShandilya Any update?

Yeah right so I proposed that I might have found the solution for this before to Kevin. It was this:
While inspecting I found the code to be here but if you open the same which is located in header.html file under _includes directory the code to display design is not there so maybe website automatically fetches the design.md file instead of one in index directory.

image
image

Link to header.html file: https://github.com/armadaproject/armada/blob/gh-pages/_includes/header.html

@Sharpz7
Copy link
Contributor

Sharpz7 commented Aug 22, 2023

@ShivangShandilya Nice spot! Feel free to make the PR

@Sharpz7 Sharpz7 added bug Something isn't working type/documentation Improvements or additions to documentation component/contribex Contribution Experience labels Aug 24, 2023
This was referenced Sep 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working component/contribex Contribution Experience good first issue Good for newcomers type/documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

7 participants