Update link to be absolute, else it looks for a file within the repo (corrected approach for #49) #51
Conversation
|
Could you try the |
AmeliaYe
requested review from
rmkraus and
AmeliaYe
and removed request for
rmkraus
|
The plot thickens :) We have some environment differences which are causing significant changes in my make output. In some cases it's minor formatting, but an indentation difference on every line means that it looks like there have been lots of changes to the file. In other cases it is more significant because there are some real changes which seem to not be a problem. In any case, I'm updating this PR to include a proposal for a more complete solution which eliminates this concern and also removes the requirement for devs to compile the README. When changes are made to docs, the README will automatically be generated and added to the PR. At least that's the plan... Working through some things let me confirm I'll reply and @ mention you once I have an update. |
brainwavecoder9
force-pushed
the
link-fix
branch
from
70fc5e9 to
409f868
Compare
|
Closing this to reset the branch and make other changes... will open an new PR; will be less to sort out if I submit something clean. Will submit a new PR when that updated code is confirmed and ready. |
## SUMMARY A number of changes to improve and automate the documentation build, and a little cleanup. ## EXPLANATION When trying to run `make` to build the README for #51 I ended up down a rabbit hole trying to get my build environment to be consistent (as did someone else in #24). Even after what I thought was a successful run, I still ended up with a slightly different format, which can make a very minor change seem quite complicated. Although there are a number of changes to this README, these are expected to be normalized through the new process so future changes are expected to be consistent. This modification to the documentation creation process automates the build process in an isolated environment for creating the README file. Additionally, a few other small changes were made to cleanup the repo and related process. A summary of all changes is below. ## DESCRIPTION OF CHANGES `.github/workflows/generate-documentation.yml` - New file enables the README `make` process to run within a GitHub Action. This defines dependencies and ensures consistency for the process, means anyone modifying documentation does not have to configure a local environment, and automates the process so that the make command never needs to be run manually. This will automatically run to create and commit the README, but only after a commit is made to the docs folder. `.gitattributes` - modified to use lf line endings for MD files, nice for consistency generally, and required for local build process. `docs/Makefile` has a number of changes: - upgraded syntax for 3.x pandoc to address deprecation [WARNING] - _markdown section updated to only execute python scripts. a bit cleaner than blindly attempting to execute text files - PYTHONPATH set to fix issue where chain_server was not available `docs/0_2_999_footer.md` - removed an empty file that is not referenced, probably left over from changes made by Ryan Kraus in June (4477e66 & bd71c95) `docs/0_1_personal_key.md` - URL link fix, which was the original issue resolved as part of: #49 `docs/3.2_docs.md` - Remove reference to `make`, added additional clarifying info, and let users know that the process will happen automatically `.static/*` - A number of files automatically updated as part of the build process, referenced by the README --------- Co-authored-by: GitHub Actions <actions@github.com>
This PR is tiny and simple update to change a failing relative link to be an absolute link.
Thanks for the great intro! We're using this as a reference for a multi-container setup (also understanding that another way of doing this is coming soon). In any case, found a minor issue that causes a clickable link to fail for the NGC catalogue.
In browser the markdown style link to the NGC is interpreted as a regular file... so clicking it in some conditions takes you to a non-existent file: