Skip to content

Commit 17cc783

Browse files
authored
Merge pull request #18 from nsidc/update-to-homepage-trey
Update to homepage - Trey's edits
2 parents 1c9dea7 + f18fa76 commit 17cc783

File tree

4 files changed

+26
-23
lines changed

4 files changed

+26
-23
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
11
# Contributing
22

3-
## Authoring a post
3+
## Local development
44

5-
* Create a new directory for your post following existing directory structure
6-
pattern
7-
* Name the directory after your post
5+
First, create a local envirionment with `quarto` installed:
86

9-
* Name the markdown file containing your blog post `index.md`
10-
* _Only_ name it `index.qmd` if the file is computational markdown, i.e.
11-
contains executable code.
7+
```
8+
conda env create -f environment.yml
9+
conda activate nsidc-github-pages
10+
```
1211

13-
* Populate markdown front-matter with metadata following pattern from existing
14-
posts
15-
* Include `title`, `description`, `author`, `date`, and `categories`
16-
fields.
17-
* Description should be a one-sentence introduction to the post.
12+
Next, startup the quarto development server:
1813

19-
* Include any images or other assets that are specific to this post in the
20-
post's directory
14+
```
15+
quarto preview
16+
```
17+
18+
And finally, start developing content! Changes to content should get
19+
automatically updated in your browser.

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
# NSIDC Github Web homepage
1+
# NSIDC Github Pages
22

3-
This is landing page for NSIDC github websites.
3+
This is landing page for NSIDC [GitHub Pages](https://pages.github.com/)-based
4+
websites.
45

5-
The website is built in GitHub Actions by [Quarto](https://quarto.org/), a modern technical
6-
publishing tool. The website is deployed to GitHub Pages.
6+
The website is built in GitHub Actions by [Quarto](https://quarto.org/), a
7+
modern technical publishing tool. The website is deployed to [GitHub
8+
Pages](https://pages.github.com/).

environment.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: "nsidc-technical-blog"
1+
name: "nsidc-github-pages"
22
channels:
33
- "conda-forge"
44
- "nodefaults"

index.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
---
2-
title: "NSIDC"
2+
title: "NSIDC GitHub Pages"
33
---
44

5-
Welcome to the NSIDC github websites home page.
5+
Welcome to the NSIDC [GitHub Pages](https://pages.github.com/) home page. This site serves as a landing-page for all of NSIDC's GitHub Pages-hosted websites:
66

7-
## [NSIDC Data Cookbook](nsidc.github.io/NSIDC-Data-Cookbook/)
8-
## [NSIDC Technical Blog](https://nsidc.github.io/NSIDC-Technical-Blog/)
7+
* [NSIDC Data Cookbook](https://nsidc.github.io/NSIDC-Data-Cookbook/): A guide
8+
to searching, accessing and working with NSIDC data.
9+
* [NSIDC Technical Blog](https://nsidc.github.io/NSIDC-Technical-Blog/): A blog
10+
by and for NSIDC developers.

0 commit comments

Comments
 (0)