Conversation
|
🚀 Deployed on https://deploy-preview-151--approach-guide.netlify.app |
At least in the blog section
ronnyhdez
reviewed
Mar 21, 2026
approach/documentation.qmd
Outdated
|
|
||
| When we draft posts we do in Google Docs for easy edits then move to Quarto. We have a Google folder [ OpenscapesCommsEngagement > Blogs ] full of google docs where we start drafts and ask others to review, comment, suggest edits as needed. The workflow:creating the blogpost in google docs. Review/approval. Move to a qmd file (can copy from a formatted google doc to a qmd in Visual Editor mode of RStudio or Positron, then edit further as needed) and then PR of the qmd file to the main repo. | ||
|
|
||
| If we're drafting in Quarto first (which we have done to test/practice what it's like to use GitHub review features) we can borrow a practice from rOpenSci from Stef: "we moved to 80 char lines for that reason. So much easier to review & make suggested commits." |
Collaborator
There was a problem hiding this comment.
I would suggest keeping text wrapped at ~80 characters in Quarto files. In my experience, this makes diffs and reviews much easier to read and work with.
approach/documentation.qmd
Outdated
| 3. **Share with co-authors early.** But not too early. Often we are trying to do the legwork to get a blog post structured and drafted describing the work they've already put into the event or slides. So along with the next point, do this until it's good enough, and share! | ||
| 4. **Be ok with imperfect, and done!** Yes, there is more to say if you put months of time into this. And we may find a sentence to be polished after posting, and that's ok. We aim to share ideas and momentum from our community with the mindset that sharing some and imperfectly is better than silence. | ||
|
|
||
| When we draft posts we do in Google Docs for easy edits then move to Quarto. We have a Google folder [ OpenscapesCommsEngagement > Blogs ] full of google docs where we start drafts and ask others to review, comment, suggest edits as needed. The workflow:creating the blogpost in google docs. Review/approval. Move to a qmd file (can copy from a formatted google doc to a qmd in Visual Editor mode of RStudio or Positron, then edit further as needed) and then PR of the qmd file to the main repo. |
Collaborator
There was a problem hiding this comment.
I'll include this workflow as a list of steps.
Contributor
Author
There was a problem hiding this comment.
Looks great, thanks Ronny!
Update blog documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hi @ronnyhdez and @stefaniebutland, I started new documentation by pasting from Slack. Ronny, as you go could you please add a bit more that will help Future You/Us? Thank you!