diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1b5c95e..3bede02 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,28 @@ # Contributing -TODO write docs for staff here +We welcome contributions from any current or former UC Berkeley course staff or instructors +by submitting a pull request and requesting a review from any of our [maintainers]({% link about.md }) +If you're not sure what to work on or would like to submit a bug report, +see our open [GitHub issues](https://github.com/berkeley-cdss/docs/issues). + +## Installation + +See [README.md](README.md) + +## just-the-docs Theme + +Don't reinvent the wheel! Many features come out-of-the-box since this website +uses the [just-the-docs](https://just-the-docs.com/) Jekyll theme. If you want to have things like +callouts, tables of contents, etc. check their documentation first. + +## Style + +When creating a new page, make sure that it goes in the appropriate category. +Page titles should match their file names, which will also be used as the slug +for the page. For example, if your page is titled "A New Page Title," your +Markdown file should be named `a-new-page-title.md` so that the slug for that +page is `/a-new-page-title`. Be aware that renaming titles and files +will break existing downstream links and having consistency is useful for organization! ## Liquid Tags @@ -12,7 +34,8 @@ Some tags you may find useful: ## Continuous Integration (GitHub Actions) -TODO Info here about workflows and links +We use [GitHub Actions](https://docs.github.com/en/actions) for continuous integration status checks, +such as running web accessiblity tests and code style checks/linters/autoformatters. Most of the linters in `.github/workflows/linters.yml` are powered by [reviewdog](https://github.com/reviewdog/reviewdog). @@ -20,7 +43,7 @@ Run `bundle exec rubocop` to run [Rubocop](https://rubocop.org/). To autocorrect ## Testing -To run tests, run `bundle exec rspec` +To run web accessibility tests, run `bundle exec rspec`. ## Resources diff --git a/README.md b/README.md index 2731143..e4002e0 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,13 @@ # CDSS Common Documentation -[![Deploy Jekyll site to Pages](https://github.com/berkeley-cdss/docs/actions/workflows/jekyll.yml/badge.svg)](https://github.com/berkeley-cdss/docs/actions/workflows/jekyll.yml)[![Run all page tests](https://github.com/berkeley-cdss/docs/actions/workflows/rspec.yml/badge.svg)](https://github.com/berkeley-cdss/docs/actions/workflows/rspec.yml) +[![Deploy Jekyll site to Pages](https://github.com/berkeley-cdss/docs/actions/workflows/jekyll.yml/badge.svg)](https://github.com/berkeley-cdss/docs/actions/workflows/jekyll.yml) + +[![Run all page tests](https://github.com/berkeley-cdss/docs/actions/workflows/rspec.yml/badge.svg)](https://github.com/berkeley-cdss/docs/actions/workflows/rspec.yml) ## Installation ### Install Ruby and Bundler + **The berkeley-class-site template requires Ruby 3.3.7 or higher and bundler >= 2.6** Install Ruby before continuing. You can check your Ruby version by running: @@ -17,14 +20,20 @@ Prerequisites: - You have everything that [Jekyll requires](https://jekyllrb.com/docs/installation/) - You have installed [Bundler](https://bundler.io/): Run `gem install jekyll bundler` -- Clone this repository -- Install dependencies with `bundle install` + +## Clone the repository and install dependencies + +```bash +git clone git@github.com:berkeley-cdss/docs.git +bundle install +``` ## Usage To run the site locally, run: -``` +```bash +cd bundle exec jekyll serve ``` @@ -36,7 +45,7 @@ Via [GitHub Pages](https://docs.github.com/en/pages/setting-up-a-github-pages-si ## Contributing -Please use pull requests! +See [CONTRIBUTING.md](CONTRIBUTING.md) ## License