Skip to content

Latest commit

 

History

History
164 lines (131 loc) · 7.62 KB

CONTRIBUTE.md

File metadata and controls

164 lines (131 loc) · 7.62 KB
Raw

Testing website edits locally

The following script can take a fresh Ubuntu VM and get a local copy of the website running. The bundle exec call at the end reports the URL to use, typically http://localhost:4000/.

#!/bin/bash

# This software was developed at the National Institute of Standards
# and Technology by employees of the Federal Government in the course
# of their official duties. Pursuant to title 17 Section 105 of the
# United States Code this software is not subject to copyright
# protection and is in the public domain. NIST assumes no
# responsibility whatsoever for its use by other parties, and makes
# no guarantees, expressed or implied, about its quality,
# reliability, or any other characteristic.
#
# We would appreciate acknowledgement if the software is used.

# This script will clone the CASE website repository under ~/local/src,
# if not already cloned there, and execute a local Jekyll build of the
# website for testing in a browser.
# This script has been tested in an Ubuntu environment.

set -x
set -e
set -u

# Guarantee website-essential packages installed.
# dpkg tip for confirming package installation via:
#   https://stackoverflow.com/a/1298103
run_install=no
dpkg -s git \
  || run_install=yes
dpkg -s jekyll \
  || run_install=yes
dpkg -s zlib1g-dev \
  || run_install=yes
if [ "xyes" == "x${run_install}" ]; then
  sudo apt install \
    --yes \
    git \
    jekyll \
    zlib1g-dev
fi

mkdir -p ${HOME}/local/src
pushd ${HOME}/local/src
  if [ ! -d cdo.github.io ]; then
    git clone \
      https://github.com/Cyber-Domain-Ontology/cdo.github.io.git
  fi

  pushd cdo.github.io
    bundle --version \
      || sudo gem install bundler:2.0.2

    bundle install \
      --path vendor/bundle

    # Serve built website.
    # Via:
    #   https://help.github.com/en/github/working-with-github-pages/testing-your-github-pages-site-locally-with-jekyll
    bundle exec jekyll serve
  popd #cdo.github.io
popd #${HOME}/local/src

Review checklists

These checklists are documented on the Development of CDO Ontologies page. Due to a display issue with website font colors, they are presented here.

Issue progress

# Coordination

- Tracking in Jira ticket [TODO](#TODO-link)
<!--
Include in administrative review how well the competencies demonstrate the requirements.
-->
- [ ] Administrative review completed, proposal announced to Ontology Committees (OCs) on TODO-date
- [ ] Requirements to be discussed in OC meeting, date TBD
<!--
If this is deemed a "Fast-track" proposal, delete the above line and Requirements Review vote line.
-->
- [ ] Requirements Review vote has not occurred
<!--
One of these lines can be swapped in when ready:
- [ ] Requirements Review vote is open until TODO-datetime
- [x] Requirements Review vote occurred, passing, on TODO-date
- [x] Requirements Review vote occurred, not passing and not planned to revisit, on TODO-date
In event of the latter, delete the remainder of the list.
-->
- [ ] *Requirements development phase completed.*
- [ ] Solution announced to OCs on TODO-date
- [ ] Solutions Approval to be discussed in OC meeting, date TBD
- [ ] Solutions Approval vote has not occurred
<!--
One of these lines can be swapped in when ready:
- [ ] Solutions Approval vote is open until TODO-datetime
- [x] Solutions Approval vote occurred, passing, on TODO-date
- [x] Solutions Approval vote occurred, not passing, on TODO-date
In event of the latter, delete the remainder of the list.
-->
- [ ] *Solutions development phase completed.*
- [ ] [Backwards-compatible implementation](#TODO-link-to-PR) merged into `develop` for the next release
- [ ] `develop` state with backwards-compatible implementation [merged](#TODO-link-to-PR) into `develop-2.0.0`
- [ ] [Backwards-incompatible implementation](#TODO-link-to-PR) merged into `develop-2.0.0` (or *N/A*)
- [ ] Milestone linked
- [ ] Documentation logged in pending release page
- [ ] _Prerelease publication_: CASE `develop` branch [updated](#TODO-link-to-CASE-PR) to track UCO's updated `develop` branch
- [ ] _Prerelease publication_: CASE `develop-2.0.0` branch [updated](#TODO-link-to-CASE-PR) to track UCO's updated `develop-2.0.0` branch

Pull request review

To be inlined into the initial Pull Request description, as an edit by OC Chair or Coordinator:

# Coordination

- Tracking in Jira ticket [TODO](#TODO-link) <!-- Only for when no Issue is associated -->
- [ ] Pull Request is against correct branch
- [ ] Pull Request is in, or reverted to, Draft status before Solutions Approval vote has passed
- [ ] CI passes in (CASE/UCO) feature branch against (`develop`/`develop-2.0.0`)
- [ ] CI passes in UCO current `unstable` branch ([merge-commit](#TODO-commit))
- [ ] CI passes in CASE current `unstable` branch tracking UCO's `unstable` as submodule ([merge-commit](#TODO-commit)) <!--If this is a purely additive change, this box may be checked with a note of "*(skipped - additive change)*" -->
- [ ] Impact on SHACL validation [reviewed](#TODO-commit) for CASE-Examples
- [ ] Impact on SHACL validation [remediated](#TODO-commit) for CASE-Examples <!--In primary or feature branch, no ...validation-unstable.ttl files show negative impact from PR.-->
- [ ] Impact on SHACL validation [reviewed](#TODO-commit) for casework.github.io
- [ ] Impact on SHACL validation [remediated](#TODO-commit) for casework.github.io <!--In primary or feature branch, no ...validation-unstable.ttl files show negative impact from PR.-->
- [ ] Milestone linked
- [ ] Solutions Approval vote logged on corresponding Issue (once logged, can be taken out of Draft PR status) <!-- Non-applicable for PRs functioning under bugfix worflow -->

Next-major pull request review

This checklist is to be provided as the initial Pull Request description for PRs that catch develop-2.0.0 up with the current develop.

# Coordination

- [ ] Pull Request is against correct branch
- [ ] Pull Request is in Draft status before CI has passed
- [ ] CI passes in (CASE/UCO) feature branch against `develop-2.0.0`
- [ ] Milestone linked

Maintaining the Project Release Flow diagram

This page links to a diagram showing the release flow of various CDO projects and their consumers.

Updates to the diagram are welcome from the community. The logistics of updating are as follows:

  • If an update to one of the referenced elements is made and the diagram has fallen out of sync., notice of the update as a GitHub Issue on this repository is sufficient for an update to be made. The community member should let the website maintainers know they'd like assistance with finishing the request.
  • If a community member wishes to make the update themselves, the records are maintained in a Dot (i.e. GraphViz) file, here. The appropriate definition can be updated, and a pull request filed.
  • The CDO website currently does not fully automate updates to the rendered figure when the Dot source is updated. Part of the Pull Request review will include a website maintainer pulling the update down and running make to regenerate the figure, if the community member did not do that themselves. (And, this is understandable - Make and GraphViz are not provisioned by default in some computing environments.)
    • It is certainly welcome for the community member to take the extra step of running make locally after making their edits to the .dot file.