Skip to content

Commit

Permalink
Merge pull request #13 from ruralinnovation/dev/BLOG-22-fix-blog-styles
Browse files Browse the repository at this point in the history
update workflow instructions
  • Loading branch information
tech-team-rural-mda authored Aug 8, 2024
2 parents b716770 + c1bf240 commit 423eaea
Show file tree
Hide file tree
Showing 7 changed files with 38 additions and 14 deletions.
29 changes: 23 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,29 @@

## Blog post workflow

1. Create a new branch (`git branch -d YOUR_BRANCH_NAME`) and add a new folder in the `posts` directory.
2. Add an `index.qmd` file (where your blog post will go) and a `thumbnail.png` file (an image that will appear with the post listing)
3. Write your blog post. Using the command line, navigate to the blog's folder and run `quarto preview` to view your changes in the browser.
4. Commit your changes and push a new remote branch (`git push -u origin YOUR_BRANCH_NAME`) to Github.
5. Have another team member review your pull request.
5. Merge your changes and then, to update the blog, run `quarto publish gh-pages`.
1. Draft blog post
1. Create a short name representing the title for your article. This should be lowercase with underscores instead of spaces. Use this name to create a new branch (`git branch -d your_branch_name`) and add a new folder in the `posts` directory (`mkdir posts/your_branch_name`).
2. Within the new folder, add an `index.qmd` file (where your blog post will go) and a `thumbnail.png` file (an image that will appear in the listing of recent articles; screenshots are OK, but charts/diagrams/infographics are better).
3. Write your blog post. Using the command line, navigate to the root folder of the blog project and run `quarto preview` (or use the “Render” button in RStudio) to view your changes in the browser.
2. Commit changes and publish to Github with (Draft) in the title
3. Copy text into a google doc
1. Make the document title = blog post's full title
2. In the google doc, add a link to the blog post's folder in Github ([ex.](https://github.com/ruralinnovation/blog/tree/main/posts/awesomejq))
4. Let Austin know that there is a blog post ready for review
5. Austin will edit the blog post (over the next 5 days)
1. If you don’t see any edits/suggestions, do not assume that it’s perfect. Reach out and confirm with Austin
6. Once Austin’s feedback is the document, action suggestions/edits (only if it makes sense)
7. Migrate edits over to the blog’s quarto file (locally)
8. Publish final changes:
1. Commit to blog post branch:
1. In reference to step 1 above for drafting a blog post, check out the same branch that you used to initially create the article.
2. Edit your blog post. Using the command line, navigate to the root folder of the blog project and run `quarto preview` (or use the “Render” button in RStudio) to view your changes in the browser.
1. If you didn’t use the RStudio “Render” button to preview your changes, you now need to run `quarto render` in your terminal to output new files to the `docs` directory.
2. If you preview and notice that there are style issues, either fix it or flag the issue for your reviewer after you push the changes
3. Stage your updates (including file changes in `docs`) and commit your changes (`git commit -m “[message]”`). Push a new remote branch (`git push -u origin your_branch_name`) to Github
2. Create a pull request to merge blog post branch into `main`.
1. Have another team member review your pull request.
2. Merge your changes


## Communications with com's
Expand Down
2 changes: 1 addition & 1 deletion docs/assets/output.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,7 @@ <h3 class="no-anchor listing-title">
</a>
</div>
</div>
<div class="quarto-post image-right" data-index="3" data-categories="code,sf,ggplot2,leaflet,spatial data" data-listing-date-sort="1716523200000" data-listing-file-modified-sort="1723091312016" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="3" data-listing-word-count-sort="448">
<div class="quarto-post image-right" data-index="3" data-categories="code,sf,ggplot2,leaflet,spatial data" data-listing-date-sort="1716523200000" data-listing-file-modified-sort="1723091560945" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="3" data-listing-word-count-sort="448">
<div class="thumbnail">
<p><a href="./posts/mapping_rural_tips/index.html" class="no-external"></a></p><a href="./posts/mapping_rural_tips/index.html" class="no-external">
<p><img loading="lazy" src="./posts/mapping_rural_tips/thumbnail.png" class="thumbnail-image"></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/posts/mapping_rural_tips/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -657,7 +657,7 @@ <h3 class="anchored" data-anchor-id="consider-non-map-alternatives">6. Consider
});
</script>
</div> <!-- /content -->
<script>var lightboxQuarto = GLightbox({"closeEffect":"zoom","descPosition":"bottom","openEffect":"zoom","selector":".lightbox","loop":false});
<script>var lightboxQuarto = GLightbox({"openEffect":"zoom","loop":false,"selector":".lightbox","closeEffect":"zoom","descPosition":"bottom"});
(function() {
let previousOnload = window.onload;
window.onload = () => {
Expand Down
2 changes: 1 addition & 1 deletion docs/posts/micropolitan_formd/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -625,7 +625,7 @@ <h1 class="title">The top 10 micropolitan areas for raising venture capital</h1>
});
</script>
</div> <!-- /content -->
<script>var lightboxQuarto = GLightbox({"openEffect":"zoom","descPosition":"bottom","loop":false,"closeEffect":"zoom","selector":".lightbox"});
<script>var lightboxQuarto = GLightbox({"openEffect":"zoom","selector":".lightbox","descPosition":"bottom","loop":false,"closeEffect":"zoom"});
(function() {
let previousOnload = window.onload;
window.onload = () => {
Expand Down
2 changes: 1 addition & 1 deletion docs/site_libs/bootstrap/bootstrap.min.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 10 additions & 3 deletions src/custom.scss
Original file line number Diff line number Diff line change
Expand Up @@ -50,17 +50,24 @@ header#quarto-header {
}

.nav-link, .nav-link.active {
color: #FFF;

.menu-text {
&:hover {
color: #FFF;
}

.menu-text, i {
color: #FBF8E9;

&:hover {
color: #FFF;
}
}
}
}
}

* a:visited {
color: #fff !important;
color: #FFF !important;
}
* a:hover {
color: #7a7a7a !important;
Expand Down

0 comments on commit 423eaea

Please sign in to comment.