Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rebased develop against main, develop -> main #68

Merged
merged 5 commits into from
Jan 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 0 additions & 15 deletions .github/workflows/config/.lycheeignore

This file was deleted.

3 changes: 1 addition & 2 deletions .github/workflows/workflow-generate-website.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@ jobs:
- name: Checkout
uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3
with:
submodules: recursive
fetch-depth: 0
- name: Install Node.js dependencies
run: "[[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true"
Expand Down Expand Up @@ -98,7 +97,7 @@ jobs:
- name: Check Links
uses: lycheeverse/lychee-action@76ab977fedbeaeb32029313724a2e56a8a393548
with:
args: --exclude-file ./.github/workflows/config/.lycheeignore --verbose --no-progress --accept 200,206,429 './website/**/*.html' --exclude-mail
args: --config ./src/lychee.toml './website/**/*.html'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Save Report
Expand Down
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@
node_modules/
src/public
src/resources/_gen


lychee_report.md
.hugo_build.lock
3 changes: 0 additions & 3 deletions .gitmodules

This file was deleted.

58 changes: 58 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
SHELL:=/usr/bin/env bash

.PHONY: help
# Run "make" or "make help" to get a list of user targets
# Adapted from https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
help: ## Show this help message
@grep -E '^[a-zA-Z_-]+:.*?##.*$$' $(MAKEFILE_LIST) | awk 'BEGIN { \
FS = ":.*?## "; \
printf "\033[1m%-30s %s\033[0m\n", "TARGET", "DESCRIPTION" \
} \
{ printf "\033[32m%-30s\033[0m %s\n", $$1, $$2 }'

.PHONY: clean
clean: clean-site clean-linkcheck ## Clean all

#
# Website generation / hugo
#

SITE_OUTPUT_DIR:=src/public

.PHONY: serve
serve: ## Spin up a static web server for local dev
cd src; hugo serve

.PHONY: site
site: $(SITE_OUTPUT_DIR) ## Build the site

$(SITE_OUTPUT_DIR):
cd src; hugo --minify

.PHONY: clean-site
clean-site: ## Clean the site
rm -fr $(SITE_OUTPUT_DIR)

#
# Checks
#

LYCHEE_OUTPUT_FILE:=lychee_report.md
LYCHEE_CONFIG_FILE:=./src/lychee.toml
# Flags that currently cannot be configured via the configuration file
LYCHEE_FLAGS:=--verbose --format markdown
# Extra flags for the user to override (used to set github token in GHA workflow)
LYCHEE_EXTRA_FLAGS:=

.PHONY: linkcheck
linkcheck: $(LYCHEE_OUTPUT_FILE) ## Generate a report of all site links

$(LYCHEE_OUTPUT_FILE): $(SITE_OUTPUT_DIR)
lychee \
--config '$(LYCHEE_CONFIG_FILE)' \
--output $(LYCHEE_OUTPUT_FILE) \
$(LYCHEE_FLAGS) $(LYCHEE_EXTRA_FLAGS) \
'$(SITE_OUTPUT_DIR)/**/*.html'

clean-linkcheck: ## Clean the linkcheck report
rm -f $(LYCHEE_OUTPUT_FILE)
11 changes: 1 addition & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,11 @@ If you have any questions about OSCAL in general or if you would like to get inv
Run the following Git command to clone the OSCAL-Pages repository, and you can begin editing content without any special setup.

```sh
git clone --recurse-submodules https://github.com/usnistgov/OSCAL-Pages.git
git clone https://github.com/usnistgov/OSCAL-Pages.git
```

The website content in this repository is generated into the full website with [Hugo](https://gohugo.io/). If you wish to run the website locally, you can either install hugo, or use Docker and docker-compose.

## Initializing for Development

This repository uses submodules to load design elements required by the website. You can initialize these submodules with the command inside the cloned repository:

```sh
cd OSCAL-Pages
git submodule update --init --recursive
```

## Using Hugo

In terminal:
Expand Down
Empty file removed src/.hugo_build.lock
Empty file.
22 changes: 0 additions & 22 deletions src/archetypes/complete-reference/_index.md

This file was deleted.

15 changes: 0 additions & 15 deletions src/archetypes/complete-reference/json-definitions.md

This file was deleted.

15 changes: 0 additions & 15 deletions src/archetypes/complete-reference/json-index.md

This file was deleted.

14 changes: 0 additions & 14 deletions src/archetypes/complete-reference/json-outline.md

This file was deleted.

15 changes: 0 additions & 15 deletions src/archetypes/complete-reference/json-reference.md

This file was deleted.

15 changes: 0 additions & 15 deletions src/archetypes/complete-reference/xml-definitions.md

This file was deleted.

15 changes: 0 additions & 15 deletions src/archetypes/complete-reference/xml-index.md

This file was deleted.

14 changes: 0 additions & 14 deletions src/archetypes/complete-reference/xml-outline.md

This file was deleted.

15 changes: 0 additions & 15 deletions src/archetypes/complete-reference/xml-reference.md

This file was deleted.

22 changes: 0 additions & 22 deletions src/archetypes/model-reference/_index.md

This file was deleted.

15 changes: 0 additions & 15 deletions src/archetypes/model-reference/json-definitions.md

This file was deleted.

15 changes: 0 additions & 15 deletions src/archetypes/model-reference/json-index.md

This file was deleted.

Loading
Loading