Skip to content

Commit 0fc7a29

Browse files
hautenhauten
committed
fix headings & update RADIUSS details
1 parent 5f2c70b commit 0fc7a29

1 file changed

Lines changed: 21 additions & 21 deletions

File tree

‎about/contributing.md‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -47,23 +47,23 @@ Finally, open <http://localhost:4000> in a web browser.
4747

4848
*Note:* The [RADIUSS website](https://software.llnl.gov/radiuss/) and [product catalog](https://software.llnl.gov/radiuss/projects/) "live" on this URL but are managed by a [separate repo](https://github.com/LLNL/radiuss).
4949

50-
### Tips
50+
## Tips
5151

5252
The gems in your sourcefile get updated frequently. It is a good idea to occasionally run `bundle update` from within your project's root directory to make sure the software on your computer is up to date.
5353

5454
Sometimes there can be dependency conflicts if your local version of Ruby is different from this repo or GitHub pages deployment settings. You can find the version number of each of GitHub Page's current dependency's [here](https://pages.github.com/versions/). You can often avoid dependency issues if you use the same versions, including for Ruby.
5555

5656
For example, the default version of Ruby used to deploy GitHub Pages on github.com as of 2021-04-08 was Ruby 2.7.1. If you tried running Ruby version 3.0.0 locally on macOS, you'll need to do some extra steps to correctly install the dependencies for this repository. You'd need to run `bundle add webrick` as it is no longer a prepackaged dependency with Ruby in 3.0.0. You may also need to run `gem install eventmachine -- --with-openssl-dir=/usr/local/opt/openssl@1.1` as MacOS >10.14 doesn't use OpenSSL from the same path as is still assumed to be in by eventmachine.
5757

58-
### Spellcheck
58+
## Spellcheck
5959

6060
The [GitHub workflow](https://github.com/LLNL/llnl.github.io/blob/main/.github/workflows/main.yaml) currently includes an action for a Rust tool called [crate-ci/typos](https://github.com/marketplace/actions/typos-action) that will spellcheck all posts and pages. If your CI fails, spelling suggestions will be shown and you can manually update the mistakes, or [install typos](https://github.com/crate-ci/typos#install) and have all errors fixed automatically:
6161

6262
```bash
6363
typos ./_posts ./README.md ./about/faq.md ./about/contributing.md --write-changes
6464
```
6565

66-
If a word needs to be ignored, see [instructions](https://github.com/crate-ci/typos#false-positives) for adding an entry to the [_typos.toml](https://github.com/LLNL/llnl.github.io/blob/main/_typos.toml) file.
66+
If a word needs to be ignored, see [instructions](https://github.com/crate-ci/typos#false-positives) for adding an entry to the [`_typos.toml`](https://github.com/LLNL/llnl.github.io/blob/main/_typos.toml) file.
6767

6868
{% endcapture %}
6969
{% assign accordionContent = accordionContent | markdownify %}
@@ -112,11 +112,11 @@ Repos that appear on the [RADIUSS site](https://software.llnl.gov/radiuss/projec
112112

113113
{% capture accordionContent %}
114114

115-
### Project Tags
115+
## Project Tags
116116

117117
See the FAQ [How do I include my repo in the LLNL organization and/or this website’s catalog?](https://software.llnl.gov/about/faq/#catalog) for information about tagging an individual repo. See the topic [How do I update or use the catalog categories?](https://software.llnl.gov/about/contribute/#categories) above for information about managing the categories.
118118

119-
### Project Logos
119+
## Project Logos
120120

121121
The home page displays a logo next to each repo when they appear under the topic categories. If a repo has its own logo, that should display. If not, then the LLNL logo displays by default. There are two steps to adding a logo to this website:
122122

@@ -167,7 +167,7 @@ The informational pages on this site (e.g., this page, [About](/about), [FAQ](/a
167167
* News post titles in title case
168168
* Accordion titles in the form of a sentence-case question
169169

170-
**To update the banner on the home page:** The existing RADIUSS message is in a container using the [`button.html` include file](https://github.com/LLNL/llnl.github.io/blob/main/_includes/components/button.html).
170+
**To update the banners on the home page:** The existing RADIUSS and IPO messages are in `<div>` containers using the [`button.html` include file](https://github.com/LLNL/llnl.github.io/blob/main/_includes/components/button.html).
171171

172172
**To modify the site menu:** Update the menu in the [`header.html`](https://github.com/LLNL/llnl.github.io/blob/main/_includes/header.html), rather than adding each page to the menu using page attributes.
173173

@@ -180,17 +180,17 @@ The informational pages on this site (e.g., this page, [About](/about), [FAQ](/a
180180
{% capture accordionContent %}
181181
This site's [visualizations](../../visualize) are governed by several scripts and queries. See the following `README` files for details:
182182

183-
* [scripts/README.md](https://github.com/LLNL/llnl.github.io/blob/main/_visualize/scripts/README.md): data collection scripts
184-
* [_visualize/README.md](https://github.com/LLNL/llnl.github.io/blob/main/_visualize/README.md): queries to GitHub's GraphQL API
185-
* [visualize/README.md](https://github.com/LLNL/llnl.github.io/blob/main/visualize/README.md): data storage
183+
* [`scripts/README.md`](https://github.com/LLNL/llnl.github.io/blob/main/_visualize/scripts/README.md): data collection scripts
184+
* [`_visualize/README.md`](https://github.com/LLNL/llnl.github.io/blob/main/_visualize/README.md): queries to GitHub's GraphQL API
185+
* [`visualize/README.md`](https://github.com/LLNL/llnl.github.io/blob/main/visualize/README.md): data storage
186186

187187
{% endcapture %}
188188
{% assign accordionContent = accordionContent | markdownify %}
189189
{% include components/accordion.html title='How do I modify the visualizations?' slug='viz' content=accordionContent %}
190190

191191
{% capture accordionContent %}
192192

193-
### Future Materials Science category
193+
## Materials Science Category
194194

195195
Add `Materials Science` into the catalog browse by adding this code (alphabetically among the other categories) to `/visualize/github-data/category_info.json`:
196196

@@ -211,11 +211,11 @@ Add `Materials Science` into the catalog browse by adding this code (alphabetica
211211
]
212212
},
213213

214-
### Deprecated RADIUSS features
214+
## RADIUSS Features
215215

216-
April 2022: RADIUSS launched at [github.com/llnl/radiuss](https://github.com/llnl/radiuss). See tasks in [issue 567](https://github.com/LLNL/llnl.github.io/issues/567). If we ever want/need to reinstate RADIUSS browsing, branding, and other features on this site, here's what to do:
216+
April 2022: RADIUSS launched at [github.com/llnl/radiuss](https://github.com/llnl/radiuss). See tasks in [issue 567](https://github.com/LLNL/llnl.github.io/issues/567). If we ever want/need to reinstate RADIUSS browsing, branding, and other features on *this* site, here's what to do:
217217

218-
* Add `RADIUSS` back into the catalog browse (i.e., to "live" on this website) by adding this code (as lines 154-168) to `/visualize/github-data/category_info.json`:
218+
* Add `RADIUSS` back into the catalog browse (i.e., to "live" on this website) by replacing the existing code (lines 190–205) in `/visualize/github-data/category_info.json` with this:
219219

220220
```bash
221221
"RADIUSS": {
@@ -235,9 +235,9 @@ April 2022: RADIUSS launched at [github.com/llnl/radiuss](https://github.com/lln
235235
},
236236
```
237237

238-
Note that `/project/category_info_radiuss.json` is not currently being used. If it were to be reinstated, it would need its categories updated to match the latest Catalog (e.g., `Docs and Tutorials``).
238+
Note that `/project/category_info_radiuss.json` is not currently being used. If it were to be reinstated, it would need its categories updated to match the latest Catalog (e.g., `Docs and Tutorials`).
239239

240-
* Comment back in lines 31-38 in `Category.service.js`
240+
<!--* Comment back in lines 31-38 in `Category.service.js`
241241
242242
```bash
243243
this.containsRadiussTopics = function(catTopics, repoTopics) {
@@ -248,23 +248,23 @@ Note that `/project/category_info_radiuss.json` is not currently being used. If
248248
}
249249
return false;
250250
};
251-
```
251+
```-->
252252

253253
* Update link/text on home page
254-
* Update links/text on Policies & Guidelines page
255-
* Update links/text on FAQ page
254+
* Update links/text on [Policies & Guidelines](/about/policies)
255+
* Update links/text on [FAQ](/about/faq)
256256
* Update relevant READMEs
257257
* Update links/text on <https://dev.llnl.gov/radiuss/>
258258
* Point URL alias <https://radiuss.llnl.gov> back to `/explore/#/RADIUSS` (request this of <webmaster-comp@llnl.gov>)
259259

260260
No changes yet, if ever:
261261

262-
* Policies & Guidelines are currently still on this site: (/about/policies)
263-
* RADIUSS logo (`radiuss.svg`) is still in the `/assets/` folder
262+
* [Policies & Guidelines](/about/policies) are currently still on this site
263+
* RADIUSS logo (`radiuss-icon-bw.png`) is still in the `/assets/images/` folder
264264

265265
{% endcapture %}
266266
{% assign accordionContent = accordionContent | markdownify %}
267-
{% include components/accordion.html title='For site admins only: notes on future and deprecated features' slug='admins' content=accordionContent %}
267+
{% include components/accordion.html title='For site admins: notes on deprecated features' slug='admins' content=accordionContent %}
268268

269269
</div>
270270
<!-- END: Accordions -->

0 commit comments

Comments
 (0)