Repository navigation
Broken links on tutorials page #60
Description
From the develop documentation page: https://pecanproject.github.io/documentation/develop/
- Click "PEcAn Demos"
- note that all of the links to "Rmd" are broken
- The Rmd files on the underlying page (inside the frame) work: https://pecanproject.github.io/pecan-documentation/develop/demo-table.html
What works:
- although only two html links are present, they work
- if you right click the 'Rmd' hyperlink and 'copy link' you get the correct link, e.g. https://github.com/PecanProject/pecan/tree/develop/documentation/tutorials/StateAssimilation, they just don't show up inside the website frame.
Possible solutions:
- Fix the redirect
- Figure out if the issue exists on other pages & fix
- Another workaround would be to read the raw file content and display inside the docs thus:
- currently the link directs to the tutorials folder https://github.com/PecanProject/pecan/tree/develop/documentation/tutorials/StateAssimilation
- it might be better to open to the file with formatting, but I don't know why this would work if the above doesn't https://github.com/PecanProject/pecan/blob/develop/documentation/tutorials/StateAssimilation/TreeRingSDA.Rmd
- if it works to render the raw file contents, ideally with appropriate formatting, replace github.com with raw.githubusercontent.com in the file URL, thus: https://raw.githubusercontent.com/PecanProject/pecan/develop/documentation/tutorials/StateAssimilation/TreeRingSDA.Rmd
Metadata
Metadata
Assignees
Type
Projects
- Status
Activity
allgandalf commentedon Feb 3, 2025
Checking if any contributor is interesting in handling the issue: https://pecanproject.slack.com/archives/C0853U6GF71/p1738574828197779?thread_ts=1738574404.433189&cid=C0853U6GF71
harshagr70 commentedon Feb 3, 2025
Hi @allgandalf , i guess i can tackle this issue well i very well know where the code is located and what needs to be fixed !! can you please assign this to me , thank you !!
boss6825 commentedon Feb 3, 2025
already done with the work on issue so please don't start to work on this
harshagr70 commentedon Feb 3, 2025
Hey !! @boss6825 thanks for clarification , its good if you have already fixed this one , thanks !!
dlebauer commentedon Feb 10, 2025
@boss6825 awesome, please ping us in Slack once you submit a PR!
allgandalf commentedon Mar 24, 2025
@boss6825 is the PR up? can you please link it for me? i couldn't find it 😢
boss6825 commentedon Mar 24, 2025
Was working on this, currently tied up with college exams and some projects that i have to submit 🥲🥲
Will complete this as soon as i have some time 🙂
subhrat123 commentedon Mar 25, 2025
@boss6825 hey, if the issue is not solved yet, I would like to work upon it as I am new to open source I think this will be very much helpful for me to get started.
harshagr70 commentedon Mar 27, 2025
Hii @dlebauer i am ready with the solution for this , i aim to fix this now with the first solution you suggested !! and make it functional for now by redirecting the links out the frame restricting it to view inside the webpage , should i go ahead and raise a PR !?
dlebauer commentedon Mar 31, 2025
@harshagr70 yes, please do!
1 remaining item
allgandalf commentedon Mar 31, 2025
Assigned you for the issue @harshagr70 , please let us know once you have the PR up
harshagr70 commentedon Mar 31, 2025
@allgandalf The source RMD files are in the main repository (pecan) , i will raise a PR there and add a reference here !!
harshagr70 commentedon Mar 31, 2025
@allgandalf i have made the necessary changes in the source RMD file and tested the changes locally , they are working well as expected , the issue is that there are some links that i dont know currently which source or rmd files they must actually point to in order to fix them all !!
PR - PecanProject/pecan#3502
harshagr70 commentedon Apr 20, 2025
@dlebauer even though the fixes are merged now the changes are yet to be reflected , once the page gets updated by the workflow we will be good to close this issue , Thanks !!
allgandalf commentedon Apr 26, 2025
@harshagr70 sorry, i didn't catch it much ,what does it mean by:
harshagr70 commentedon Apr 30, 2025
@allgandalf sorry for confusion , the build scripts are responsible for updating all these changes to get reflected , once the build script finished building the changes , it will be reflected untill then we can keep this open to keep a track !!
harshagr70 commentedon Apr 30, 2025
@allgandalf there are two documentation pages the latest release and the latest code documentation , the changes i made are correctly reflecting on latest code documentation one , let me attach the links for ease
https://pecanproject.github.io/documentation/master/
https://pecanproject.github.io/documentation/develop/
The master/ endpoint still needs to be updated , but i remember @dlebauer mentioned that they have renamed master to main , i need to check that as well .
allgandalf commentedon Jun 17, 2025
What are the next steps here? are any actions pending from me / @dlebauer or you?
harshagr70 commentedon Jun 17, 2025
@allgandalf , here we can see that the first documentation links the master branch , which no longer exists and renamed as main , some work is left on this issue , i need to render the links in the main branch as well in order to reflect those changes here . once done we can close this issue up !! thankyou !!
harshagr70 commentedon Jun 24, 2025
@allgandalf here the issue is that in the documentation the source is expected to be in the master / folder , but as i see the workflow it now makes a new directory in the documentation repository with folder name main / , which i see is the underlying reason of the changes not getting reflected here , even when the code in the main branch is updated .
Here i see two options ,
On changing the target link to latest / instead of master / , which for now does'nt seem to be a good fix as it would potentially break other routes as well .
To render the workflow so that for the changes in the main branch , the documentation changes are written in the master / directory rather than the default which is currently , latest / for the main branch !! .
fix: Rmd links in demo table open in top window to escape iframe