|
1 |
| -# hpc.social Community Syndicated Blog |
| 1 | +# hpc.social Blogs |
2 | 2 |
|
3 |
| - |
| 3 | +Welcome to the hpc.social blogs! This is a portal for our family of blogs: |
4 | 4 |
|
5 |
| -This is the repository for the [syndicated blog](https://hpc.social/projects/blog/) for the hpc.social community! |
6 |
| -Here you can add an rss/xml feed to share stories and experiences to be presented in the |
7 |
| -[aggregated blogs feed](https://hpc.social/blog/). |
8 |
| -This repository is based on the [US-RSE community blog](https://github.com/USRSE/blog), |
9 |
| -which was also imagined, designed, and implemented by author [@vsoch](https://github.com/vsoch). |
| 5 | + - [Community Blog](https://hpc.social/community-blog/) served from [this repository](https://github.com/hpc-social/community-blog) |
| 6 | + - [Personal Blog](https://hpc.social/personal-blog/) served from [this repository](https://github.com/hpc-social/personal-blog) |
| 7 | + |
| 8 | +This central point serves to provide shared instructions for contributing to each, along with |
| 9 | +how to decide which blog your feed is scoped to. |
| 10 | + |
| 11 | +## Which blog should I add my feed to? |
| 12 | + |
| 13 | +This comes down to a simple question - are you writing from a personal blog about your work and ideas, or do you represent some kind of entity or project? |
| 14 | +In more detailed terms: |
| 15 | + |
| 16 | +- **The Personal blogs aggregator** is the "soul" of the HPC community - HPCers who are personally invested in the minutiae of the work they are doing, the projects they are working on with some content about their culture, life, and thoughts. |
| 17 | + |
| 18 | +- **The Community content aggregator**: is content from people who represent projects, ecosystems, or governance boards that talk about specific community interested content around the work they represent. The content range from release notes, tricks and tips, discussion around tooling and infrastructure, and other things that are neutrally branded. Discussion of branded topics like CUDA, SYCL, and oneAPI are ok - discussions about hardware are ok. Product announcements are not ok especially. |
| 19 | + |
| 20 | +We generally try to be inclusive, and thus have created these two spaces to support different kinds of feeds! |
| 21 | +However, if moderators of the hpc.social community receive a complaint or themselves feel that a piece of content crosses the line between "Here's a cool thing we're doing" and "Here is a product we want to sell you" that feels like a breach of trust, you will be contacted first to have discussion about how to mediate the situation, and in the worst of cases that remediation is not possible, the blog or individual post may be removed. |
| 22 | + |
| 23 | +Once you choose a blog, move on to the next steps in the instructions below! |
10 | 24 |
|
11 | 25 | ## How do I contribute my blog?
|
12 | 26 |
|
| 27 | +Each blog mentioned above serves it's own set of feeds (e.g., if people only are interested in a subset |
| 28 | +of content) and a master aggregated feed (that hits both syndicated blogs) is served from here. |
| 29 | +Thus, you can add an rss/xml feed to share stories and experiences to be presented in either feed, |
| 30 | +and it will show up in the feed for the respective repository and the [aggregated blogs feed](https://hpc.social/blog/) |
| 31 | +here. Here is how to get started, for either of the above! |
| 32 | + |
13 | 33 | 1. Fork the repository, clone to your machine, and checkout a new branch.
|
14 | 34 | 1. Add your entry to the [_data/authors.yml](_data/authors.yml) file
|
15 | 35 | 1. Generate your set of posts (instructions below)
|
16 | 36 | 1. Open a pull request to the main repository!
|
17 | 37 |
|
18 |
| -## How does it work? |
19 |
| - |
20 | 38 | ### 1. Add Metadata
|
21 | 39 |
|
22 | 40 | An center, group, or individual that has a blog, podcast, or similar feed can add their
|
@@ -91,7 +109,7 @@ Here is how to do it "for realsies":
|
91 | 109 | $ python scripts/generate_posts.py _data/authors.yml --output _posts/
|
92 | 110 | ```
|
93 | 111 |
|
94 |
| -## Development |
| 112 | +## Blog Site Development |
95 | 113 |
|
96 | 114 | To develop the site, clone the repository and then build with jekyll:
|
97 | 115 |
|
@@ -123,6 +141,14 @@ This is how the posts are generated in the continuous integration setup:
|
123 | 141 | python generate_posts.py ../_data/authors.yml --output ../_posts/
|
124 | 142 | ```
|
125 | 143 |
|
| 144 | +## How is the feed generated here? |
| 145 | + |
| 146 | +We have plans to aggregate the feeds, and for now we are pulling the |
| 147 | +personal blog feed (to ensure the current functionality with the previous |
| 148 | +blog site is consistent). If you would like to contribute automation |
| 149 | +to merge the two feeds, please open a pull request! |
| 150 | + |
| 151 | + |
126 | 152 | ## 🎨️ Thank You! 🎨️
|
127 | 153 |
|
128 | 154 | This is a modified version of [Ephesus](https://github.com/onepase/Ephesus). We
|
|
0 commit comments