NR Permitting Interoperability Exchange Specification

An easy as pie way to exchange standardized permitting information. 🥧

This website is built using Docusaurus, a modern static website generator.

Directory Structure

.github/                   - GitHub PR and Issue templates
.vscode/                   - VSCode environment configurations
blog/                      - Blog Content Root (Dormant)
docs/                      - Docs Content Root
├── docusaurus/            - Docusaurus Tutorials
├── intro/                 - PIES General Information
├── spec/                  - PIES Technical Specification
│   ├── concept/           - PIES Concept Maps
│   ├── data/              - PIES Data Type Schemas
│   ├── message/           - PIES Message Type Schemas
│   ├── resource/          - PIES Resource Type Schemas
│   └── tags.yaml          - Canonical documentation tags
├── src/                   - Docusaurus Source Code
└── static/                - Site Static Assets
bcgovpubcode.yml           - BCGov Repository Metadata
CODE-OF-CONDUCT.md         - Code of Conduct
COMPLIANCE.yaml            - BCGov PIA/STRA compliance status
CONTRIBUTING.md            - Contributing Guidelines
docusaurus.config.ts       - Main Docusaurus configuration
LICENSE                    - License (Code)
LICENSE-docs               - License (Documentation)
renovate.json              - Mend Renovate configuration
SECURITY.md                - Security Policy and Reporting
sidebars.ts                - Main Docusaurus sidebar configuration
versionUtils.mts           - PIES Versioning Utilities

Installation Guide

Get VSCode

Install Recommended Extensions

Install

npm ci

This command installs the dependencies as defined by the lockfile.

Run Local Development

npm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Static Build

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Versioning

Releasing a version requires the following actions to be done in order:

1. Run npm version with argument patch, minor or major depending on the desired outcome (e.g. npm version minor).
2. Run npm run version with the semver version to be published (e.g. npm run version 0.1.0). This will create a new Docusaurus version, and run a script to align all the schema references appropriately.

Note: You may run npm run postversion directly in the event you need to manually align all the schema references.

---

Deployment Notes

The following steps are not necessary in order to contribute to PIES as this repository contains a dedicated CI/CD pipeline.

Using SSH:

USE_SSH=true npm run deploy

Not using SSH:

GIT_USER=<Your GitHub username> npm run deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

Getting Help or Reporting an Issue

To report bugs/issues/features requests, please file an issue.

How to Contribute

If you would like to contribute, please see our contributing guidelines.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

License

This repository is dual licensed.

• Software or code by the Province of British Columbia is licensed under an AGPL v3 License

  NR Permitting Interoperability Exchange Specification
  Copyright 2024 Province of British Columbia
  
  This program is free software: you can redistribute it and/or modify
  it under the terms of the GNU Affero General Public License as published
  by the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
  
  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU Affero General Public License for more details.
  
  You should have received a copy of the GNU Affero General Public License
  along with this program.  If not, see <https://www.gnu.org/licenses/>.

• Documentation by the Province of British Columbia is licensed under a Creative Commons Attribution 4.0 International License