fix doc missing links to repo files #261
Conversation
github-actions
bot
added
ci/operations
fmigneault
force-pushed
the
fix-doc-refs
branch
from
47de90d
to
bdbf16f
Compare
fmigneault
changed the title
E2E Test ResultsDACCS-iac Pipeline ResultsBuild URL : http://daccs-jenkins.crim.ca:80/job/DACCS-iac-birdhouse/1006/Result : success BIRDHOUSE_DEPLOY_BRANCH : fix-doc-refs DACCS_CONFIGS_BRANCH : master PAVICS_E2E_WORKFLOW_TESTS_BRANCH : master PAVICS_SDI_BRANCH : master DESTROY_INFRA_ON_EXIT : true PAVICS_HOST : https://host-140-8.rdext.crim.ca PAVICS-e2e-workflow-tests Pipeline ResultsTests URL : http://daccs-jenkins.crim.ca:80/job/PAVICS-e2e-workflow-tests/job/master/813/NOTEBOOK TEST RESULTS |
E2E Test ResultsDACCS-iac Pipeline ResultsBuild URL : http://daccs-jenkins.crim.ca:80/job/DACCS-iac-birdhouse/1007/Result : failure BIRDHOUSE_DEPLOY_BRANCH : fix-doc-refs DACCS_CONFIGS_BRANCH : master PAVICS_E2E_WORKFLOW_TESTS_BRANCH : master PAVICS_SDI_BRANCH : master DESTROY_INFRA_ON_EXIT : true PAVICS_HOST : https://host-140-8.rdext.crim.ca PAVICS-e2e-workflow-tests Pipeline ResultsTests URL : http://daccs-jenkins.crim.ca:80/job/PAVICS-e2e-workflow-tests/job/master/814/NOTEBOOK TEST RESULTS
|
E2E Test ResultsDACCS-iac Pipeline ResultsBuild URL : http://daccs-jenkins.crim.ca:80/job/DACCS-iac-birdhouse/1008/Result : failure BIRDHOUSE_DEPLOY_BRANCH : fix-doc-refs DACCS_CONFIGS_BRANCH : master PAVICS_E2E_WORKFLOW_TESTS_BRANCH : master PAVICS_SDI_BRANCH : master DESTROY_INFRA_ON_EXIT : true PAVICS_HOST : https://host-140-8.rdext.crim.ca PAVICS-e2e-workflow-tests Pipeline ResultsTests URL : http://daccs-jenkins.crim.ca:80/job/PAVICS-e2e-workflow-tests/job/master/815/NOTEBOOK TEST RESULTS |
| .. _nginx.conf: ./config/proxy/nginx.conf | ||
| .. _default.env: ./default.env | ||
| .. _nginx.conf: ../birdhouse/config/proxy/nginx.conf.template | ||
| .. _default.env: ../birdhouse/default.env |
There was a problem hiding this comment.
Why go up one level then back in birdhouse/ since the file is already in birdhouse/?
There was a problem hiding this comment.
Fancy trick to detect the nested birdhouse linked under docs/bidrhouse when building docs since the root of the source changes.
| '<root>/docs/file1.rst' ===> '<build-html>/file1.html' (ref [file2]) ---> (raw '<root>/docs/file2.rst') | ||
| | | ||
| | | ||
| '<root>/docs/file2.rst' ===> '<build-html>/file2.html' <------------------------------ |
There was a problem hiding this comment.
The only problem I have had so far is to try to make it work correctly under ReadTheDocs.
Locally, it redirects fine, but ReadTheDocs triggers a file download of the "RST" with HTML contents.
Still exploring...
There was a problem hiding this comment.
You might want to ask the ReadTheDocs developper. They might hardcode some behavior on ReadTheDocs and let you know how to undo it. They might even suggest a different solution to our problem that could be more compatible.
If they have a compatible solution that allow us to avoid those ugly looking duplicate download link, this would be huge.
There was a problem hiding this comment.
Maybe an approach would simply to define redirects specifically in ReadTheDocs:
https://docs.readthedocs.io/en/latest/user-defined-redirects.html
It's somewhat manual configuration though.
Others have tried to automate it, but it's not trivial (cannot define it via config yet).
readthedocs/readthedocs.org#2904
E2E Test ResultsDACCS-iac Pipeline ResultsBuild URL : http://daccs-jenkins.crim.ca:80/job/DACCS-iac-birdhouse/1011/Result : success BIRDHOUSE_DEPLOY_BRANCH : fix-doc-refs DACCS_CONFIGS_BRANCH : master PAVICS_E2E_WORKFLOW_TESTS_BRANCH : master PAVICS_SDI_BRANCH : master DESTROY_INFRA_ON_EXIT : true PAVICS_HOST : https://host-140-8.rdext.crim.ca PAVICS-e2e-workflow-tests Pipeline ResultsTests URL : http://daccs-jenkins.crim.ca:80/job/PAVICS-e2e-workflow-tests/job/master/818/NOTEBOOK TEST RESULTS |
fmigneault
force-pushed
the
fix-doc-refs
branch
2 times, most recently
from
39d282d
to
7bb4a75
Compare
E2E Test ResultsDACCS-iac Pipeline ResultsBuild URL : http://daccs-jenkins.crim.ca:80/job/DACCS-iac-birdhouse/1012/Result : success BIRDHOUSE_DEPLOY_BRANCH : fix-doc-refs DACCS_CONFIGS_BRANCH : master PAVICS_E2E_WORKFLOW_TESTS_BRANCH : master PAVICS_SDI_BRANCH : master DESTROY_INFRA_ON_EXIT : true PAVICS_HOST : https://host-140-8.rdext.crim.ca PAVICS-e2e-workflow-tests Pipeline ResultsTests URL : http://daccs-jenkins.crim.ca:80/job/PAVICS-e2e-workflow-tests/job/master/819/NOTEBOOK TEST RESULTS |
E2E Test ResultsDACCS-iac Pipeline ResultsBuild URL : http://daccs-jenkins.crim.ca:80/job/DACCS-iac-birdhouse/1014/Result : success BIRDHOUSE_DEPLOY_BRANCH : fix-doc-refs DACCS_CONFIGS_BRANCH : master PAVICS_E2E_WORKFLOW_TESTS_BRANCH : master PAVICS_SDI_BRANCH : master DESTROY_INFRA_ON_EXIT : true PAVICS_HOST : https://host-140-8.rdext.crim.ca PAVICS-e2e-workflow-tests Pipeline ResultsTests URL : http://daccs-jenkins.crim.ca:80/job/PAVICS-e2e-workflow-tests/job/master/821/NOTEBOOK TEST RESULTS |
E2E Test ResultsDACCS-iac Pipeline ResultsBuild URL : http://daccs-jenkins.crim.ca:80/job/DACCS-iac-birdhouse/1016/Result : success BIRDHOUSE_DEPLOY_BRANCH : fix-doc-refs DACCS_CONFIGS_BRANCH : master PAVICS_E2E_WORKFLOW_TESTS_BRANCH : master PAVICS_SDI_BRANCH : master DESTROY_INFRA_ON_EXIT : true PAVICS_HOST : https://host-140-216.rdext.crim.ca PAVICS-e2e-workflow-tests Pipeline ResultsTests URL : http://daccs-jenkins.crim.ca:80/job/PAVICS-e2e-workflow-tests/job/master/823/NOTEBOOK TEST RESULTS |
| ] | ||
|
|
||
| # files that will be copied over from root repo or linked birdhouse directory | ||
| # under build directory (not copied over with same nested dir structure, directly under '_build/html') |
There was a problem hiding this comment.
is there a way to keep the nested dir structure? I just found a link that do not work, probably need nested dir structure:
https://birdhouse-deploy--261.org.readthedocs.build/en/261/optional-components/emu/docker-compose-extra.yml
There was a problem hiding this comment.
Will look into it. It will help keeping track of which file comes from it that can work.
The hard case is that some references resolve automatically with the right nesting via symlink docs/source/birdhouse -> birdhouse, but others don't (ie: anything at the root above birdhouse), and there are "conflicting cases" like CHANGES.md that should not be auto-redirected since it is indirectly integrated via docs/source/changes.rst.
| (`README <optional-components/README.rst#emu-wps-service-for-testing>`_) can be optionally added to the deployment via the `override mechanism <https://docs.docker.com/compose/extends/>`_. | ||
| Ouranos specific override can be found in this `birdhouse-deploy-ouranos <https://github.com/bird-house/birdhouse-deploy-ouranos>`_ repo. | ||
| for your organization. For an example of possible override, | ||
| see how the `emu service <optional-components/emu/docker-compose-extra.yml>`_ |
There was a problem hiding this comment.
Here's the link that did not resolve on RtD (https://birdhouse-deploy--261.org.readthedocs.build/en/261/optional-components/emu/docker-compose-extra.yml)
| for your organization. For an example of possible override, | ||
| see how the `emu service <optional-components/emu/docker-compose-extra.yml>`_ | ||
| (:download:`download </birdhouse/optional-components/emu/docker-compose-extra.yml>`) | ||
| (`README <birdhouse/optional-components/README.rst#emu-wps-service-for-testing>`_) can be optionally added to the |
There was a problem hiding this comment.
There was a problem hiding this comment.
It doesn't work in different manners per client/browser.
In Chrome (in my case at least), it shows the raw code of the HTML instead of displaying it.
In Firefox, it simply downloads the file.
E2E Test ResultsDACCS-iac Pipeline ResultsBuild URL : http://daccs-jenkins.crim.ca:80/job/DACCS-iac-birdhouse/1018/Result : success BIRDHOUSE_DEPLOY_BRANCH : fix-doc-refs DACCS_CONFIGS_BRANCH : master PAVICS_E2E_WORKFLOW_TESTS_BRANCH : master PAVICS_SDI_BRANCH : master DESTROY_INFRA_ON_EXIT : true PAVICS_HOST : https://host-140-216.rdext.crim.ca PAVICS-e2e-workflow-tests Pipeline ResultsTests URL : http://daccs-jenkins.crim.ca:80/job/PAVICS-e2e-workflow-tests/job/master/825/NOTEBOOK TEST RESULTS |
E2E Test ResultsDACCS-iac Pipeline ResultsBuild URL : http://daccs-jenkins.crim.ca:80/job/DACCS-iac-birdhouse/1019/Result : failure BIRDHOUSE_DEPLOY_BRANCH : fix-doc-refs DACCS_CONFIGS_BRANCH : master PAVICS_E2E_WORKFLOW_TESTS_BRANCH : master PAVICS_SDI_BRANCH : master DESTROY_INFRA_ON_EXIT : true PAVICS_HOST : https://host-140-216.rdext.crim.ca PAVICS-e2e-workflow-tests Pipeline ResultsTests URL : http://daccs-jenkins.crim.ca:80/job/PAVICS-e2e-workflow-tests/job/master/826/NOTEBOOK TEST RESULTS |
fmigneault
force-pushed
the
fix-doc-refs
branch
from
5cadf1c
to
c116c58
Compare
E2E Test ResultsDACCS-iac Pipeline ResultsBuild URL : http://daccs-jenkins.crim.ca:80/job/DACCS-iac-birdhouse/1023/Result : success BIRDHOUSE_DEPLOY_BRANCH : fix-doc-refs DACCS_CONFIGS_BRANCH : master PAVICS_E2E_WORKFLOW_TESTS_BRANCH : master PAVICS_SDI_BRANCH : master DESTROY_INFRA_ON_EXIT : true PAVICS_HOST : https://host-140-154.rdext.crim.ca PAVICS-e2e-workflow-tests Pipeline ResultsTests URL : http://daccs-jenkins.crim.ca:80/job/PAVICS-e2e-workflow-tests/job/master/829/NOTEBOOK TEST RESULTS |
E2E Test ResultsDACCS-iac Pipeline ResultsBuild URL : http://daccs-jenkins.crim.ca:80/job/DACCS-iac-birdhouse/1024/Result : failure BIRDHOUSE_DEPLOY_BRANCH : fix-doc-refs DACCS_CONFIGS_BRANCH : master PAVICS_E2E_WORKFLOW_TESTS_BRANCH : master PAVICS_SDI_BRANCH : master DESTROY_INFRA_ON_EXIT : true PAVICS_HOST : https://host-140-154.rdext.crim.ca PAVICS-e2e-workflow-tests Pipeline ResultsTests URL : http://daccs-jenkins.crim.ca:80/job/PAVICS-e2e-workflow-tests/job/master/830/NOTEBOOK TEST RESULTS |
Based on #260
See diff: fix-release-time-bumpversion...fix-doc-refs
Changes
Non-breaking changes
Breaking changes