-
Notifications
You must be signed in to change notification settings - Fork 13
Submitting tutorial for modeling movement in GRASS #34
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
base: main
Are you sure you want to change the base?
Conversation
I've given an incorrect name to this branch. But hopefully that won't matter for the PR. |
It would be a good idea to run this through a markdown linter , e.g. https://dlaa.me/markdownlint/ and fix at least the simple issues. We don't have it enforced (yet), but maybe we will later. Also, you need to commit the content of the _freeze folder, otherwise it won't render on the website. |
I do not have a _freeze folder anywhere. Perhaps this is a Linux item? I ran my quarto doc through this markdown linter. There are a few minor things to improve. Most of it is 'won't fix' because these are quarto defaults and not relevant for Markdown rendering, needed for the tabs, or intentional style choices that are not relevant for quarto docs. If I correct the minor things (e.g., add a space after a few lines), what is the procedure for updating this PR? |
I don't think so, it's a quarto thing. I ran my quarto doc through this markdown linter. There are a few minor things to improve. Most of it is 'won't fix' because these are quarto defaults and not relevant for Markdown rendering, needed for the tabs, or intentional style choices that are not relevant for quarto docs. It's not necessarily relevant for markdown rendering, but it's nice to have a common style. I was think of fixing all the automatic fixes, which are mostly fixing whitespace.
Switch to this branch, commit the changes and push. |
OK. I agree standardization is useful. Just not all of those suggested by the automated system. I'll make the corrections and commit. |
Mainly added some spaces and line feeds for standardized markdown
I'm getting a message that "This branch is out-of-date with the base branch". I assume that is because I committed an update with the formatting revisions. I have an option to "update merge with commit". Should I do that or let someone look at it first? |
I now see a /_freeze folder at the root of the tutorials repository on GitHub. I added my quarto file and images to /contents/tutorials. I also see that there are subfolders in /_freeze/contents/tutorials for each of the existing tutorials, which contain an html.json file. When I am using quarto in RStudio, it does not generate any file like that. Perhaps these subfolders and *.json files in /_freeze are generated within GitHub. If there is something I need to do to generate or update them in my fork, please let me know. |
If you mean the "Update branch" button, you don't need to do anything, it just means there are more recent changes on main, but as long as there is not a conflict, it's usually not needed to do anything. |
I don't know about rstudio, but if you run I think we need to revisit the deployment of this to the website and perhaps include it in the github actions, but at this point, the deployed website is rendered from the content of the _freeze folder. |
Thanks. That is what I was hoping. I also checked to see if I did not have a /_freeze folder because my code has the embed-resources: true flag for html output. But while changing the flag to false does create a folder of lib resources for the html, it does not generate a /_freeze folder. |
Our comments passed simultaneously. I'll see if I can do a quarto render to see if the file is created. |
Just tried quarto render from the command line. Worked fine but did not produce a _freeze folder. |
Is there a problem with this PR so that it can't be merged? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cool! Thanks @cmbarton and @petrasovaa! My only suggestion would be to harmonize the style, i.e., tool names are shown with links and bold, with bold, with italics, etc. Similar for other words like GUI parts or map names. IMHO, when tools are expressed as links, they do not need any further highlight. Also, the featured img is not rendered.
Co-authored-by: Veronica Andreo <[email protected]>
Co-authored-by: Veronica Andreo <[email protected]>
Co-authored-by: Veronica Andreo <[email protected]>
Co-authored-by: Veronica Andreo <[email protected]>
Co-authored-by: Veronica Andreo <[email protected]>
Co-authored-by: Veronica Andreo <[email protected]>
Co-authored-by: Veronica Andreo <[email protected]>
Co-authored-by: Veronica Andreo <[email protected]>
Co-authored-by: Veronica Andreo <[email protected]>
Can this be merged now? I don't seen any conversation that still needs resolving. |
This is a clean version of the tutorial and associated images in WebP format