-
Notifications
You must be signed in to change notification settings - Fork 6
start to update blog documentation #151
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
Open
jules32
wants to merge
4
commits into
main
Choose a base branch
from
blog-doc-update
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
5a4a11f
start to update blog documentation
jules32 e621cf3
Ref #152 move paragraphs to 80 char lines for easier review
ronnyhdez d9021df
Ref #152 include subsections and metadata structure
ronnyhdez f22a3f4
Merge pull request #153 from ronnyhdez/ronny_blog_doc_update
jules32 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -26,6 +26,11 @@ Blog posts take time. A lot of time. And they often feel extra, especially in a | |
| 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. | ||
|
|
||
| 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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. |
||
|
|
||
|
|
||
| ## Make our documentation citable | ||
|
|
||
| We want to share our documentation in a way that other people can find it, use it, improve it, and cite it. We use the Zenodo repository for this purpose. Every upload to Zenodo is assigned a Digital Object Identifier (DOI), to make it citable and trackable. | ||
|
|
||
Oops, something went wrong.
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.
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.
I'll include this workflow as a list of steps.
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.
Looks great, thanks Ronny!