Commit 70b181a7 authored by Wohlgemuth, Jason's avatar Wohlgemuth, Jason
Browse files

docs: Add contributing information

parent 1a3644aa
Loading
Loading
Loading
Loading
+14 −1
Original line number Diff line number Diff line
@@ -18,5 +18,18 @@
        "titleBar.inactiveBackground": "#00783399",
        "titleBar.inactiveForeground": "#e7e7e799"
    },
    "peacock.color": "#007833"
    "peacock.color": "#007833",
    "files.exclude": {
        "**/*.vo": true,
        "**/*.vok": true,
        "**/*.vos": true,
        "**/*.aux": true,
        "**/*.glob": true,
        "**/.git": true,
        "**/.svn": true,
        "**/.hg": true,
        "**/CVS": true,
        "**/.DS_Store": true,
        "**/Thumbs.db": true
    }
}
 No newline at end of file

CONTRIBUTING.md

0 → 100644
+40 −0
Original line number Diff line number Diff line
Contributing
============

## Requirements
- [Git](https://git-scm.com/)
- [Node.js / npm](https://nodejs.org/en)
- [Vale](https://vale.sh/) - prose linter
- [Weasyprint](https://weasyprint.org/) - PDF generator
- [Zint](https://zint.org.uk/) - QR generator

## Quick Start
- Clone repository with `git clone git@code.ornl.gov:GSHS/common/sites/fact-sheets.git`
- Navigate to project with `cd fact-sheets`
- Install dependencies with `npm install`
- Start development server with `npm run dev` (see [Commands](#commands) for more options)
- Make changes to your branch and submit a merge request

## Commands
All commands are run from the root of the project, from a terminal:

| Command                   | Action                                                   |
| :------------------------ | :------------------------------------------------------- |
| `npm install`             | Installs dependencies                                    |
| `npm run lint`            | Lint prose                                               |
| `npm run count`           | Calculate character counts                               |
| `npm run validate`        | Validate JSON data against ACORN schemas                 |
| `npm run dev`             | Starts local dev server at `localhost:4321`              |
| `npm run build`           | Build your production site to `./dist/`                  |
| `npm run preview`         | Preview your build locally, before deploying             |
| `npm run astro ...`       | Run CLI commands like `astro add`, `astro check`         |
| `npm run astro -- --help` | Get help using the [Astro](https://docs.astro.build) CLI |

## Build Process
```mermaid
graph LR
    a[TypeSpec</br>Files] --> b[JSON</br>Schemas]
    b --> d
    c[Astro</br>components] --> d[Build</br>Process]
    d --> e[HTML</br>Pages]
```
 No newline at end of file
+7 −40
Original line number Diff line number Diff line
Fact Sheets
===========
> UNDER CONSTRUCTION
Fact Sheets 2.0
===============
> Welcome to the future of fact sheets at ORNL

## 🚀 Project Structure
> [!TIP]
> Read the <abbr title="Accessible Content Organization for Research Needs">ACORN</abbr> [fact sheet](https://fact-sheets.ornl.gov/acorn/) for more information about the project

Inside of your Astro project, you'll see the following folders and files:

```text
/
├── public/
│   └── favicon.svg
├── src/
│   ├── components/
│   │   └── Card.astro
│   ├── layouts/
│   │   └── Layout.astro
│   └── pages/
│       └── index.astro
└── package.json
```

Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.

There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.

Any static assets, like images, can be placed in the `public/` directory.

## 🧞 Commands

All commands are run from the root of the project, from a terminal:

| Command                   | Action                                           |
| :------------------------ | :----------------------------------------------- |
| `npm install`             | Installs dependencies                            |
| `npm run dev`             | Starts local dev server at `localhost:4321`      |
| `npm run build`           | Build your production site to `./dist/`          |
| `npm run preview`         | Preview your build locally, before deploying     |
| `npm run astro ...`       | Run CLI commands like `astro add`, `astro check` |
| `npm run astro -- --help` | Get help using the Astro CLI                     |

Feel free to check [our documentation](https://docs.astro.build)
## Contributing
> See [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
 No newline at end of file