Skip to content

Commit

Permalink
Use new version of starter pack
Browse files Browse the repository at this point in the history
  • Loading branch information
k-dimple committed Feb 3, 2024
1 parent 98a3550 commit 3926837
Show file tree
Hide file tree
Showing 51 changed files with 2,152 additions and 617 deletions.
221 changes: 221 additions & 0 deletions .custom_wordlist.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,221 @@
GCP
LinuxONE
OCI
ROCKs
GCE
VMs
GKE
VM
EKS
vTPM
FDE
SEV
SNP
decrypted
VPC
CLI
config
SSHD
sshd
iptables
png
IPv
ipv
FIPS
CIS
Chrony
chrony
Kubernetes
Kudu
CVM
pre
amd
armhf
https
oci
powerpc
ppc
el
rootfs
ACR
ECR
OCIR
lts
ubuntu
ESM
readthedocs
SKU
linux
untrusted
programmatically
HIPAA
intranode
UA
microk
MicroK
gcloud
kubeconfig
VM's
distroless
filesystem
cryptographic
verifications
libc
libgcc
libs
SSL
openssl
tzdata
zoneinfo
runtime
Dockerfile
rustc
gcc
nsswitch
AMI
init
init's
AMIs
instantiation
ami
AmazonLinux
amiFamily
eksctl
launchTemplate
Nutanix
CentOS
Karbon
Tanzu
OpenShift
RHCOS
RHEL
SSM
OwnerId
aws
GovCloud
Anbox
ImageLocation
VIRT
hvm
pv
ebs
gp
io
xenial
paravirtual
discoverable
ENA
GPUs
softwares
livepatch
TDX
AKS
Workspaces
Juju
uptime
IAM
TPM
UEFI
cryptographically
prebuilt
keypair
NitroTPM
artifacts
AMI's
GKE's
NVIDIA
Anthos
DISA
STIG
OVAs
VMware
Graviton
AIB
ACG
SLAs
JSON
deregister
Adapter
adapter
CPUs
livepatching
lifecycle
Center
Databricks
natively
ASIC
FPGA
IOV
InfiniBand
provisioner
provisioners
EAL
Ansible
CloudFormation
Kubeflow
Istio
RBAC
macOS
microservices
MLOps
ideation
hyperparameter
checkpointing
datastores
backoff
URI
NIST
CVE
SLiM
Authorize
TCO
intra
IOPS
vCPUs
PAYG
preemptible
CVEs
DaemonSet
allocatable
Remmina
VNC
TightVNC
URL
TCP
AES
TDX
Xeon
th
TDs
VMM
EPYC
virtualised
CNCF
AgentBaker
sku
Diátaxis
reStructuredText
localhost
HTML
CUDA
G4DN
DN
OCID
AArch
VCN
EOL
EOSS
vGPU
firewalling
OpenSCAP
bzip
uncompress
hostname
DHCP
DNS
FQDN
subnet
workspaces
eks
kubelet
balancers
61 changes: 7 additions & 54 deletions .github/workflows/automatic-doc-checks.yml
Original file line number Diff line number Diff line change
@@ -1,63 +1,16 @@
name: Automatic documentation checks
name: Main Documentation Checks

on:
- push
- pull_request
- workflow_dispatch

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
cancel-in-progress: true

jobs:
spellcheck:
name: Spelling check
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3

- name: Install Aspell
run: |
sudo apt-get install aspell aspell-en
- name: Install the doc framework
working-directory: .
run: |
make install
- name: Build docs and run spelling checker
working-directory: .
run: |
make spelling
woke:
name: Inclusive language check
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3

- name: woke
uses: get-woke/woke-action@v0
with:
# Cause the check to fail on any broke rules
fail-on-error: true
workdir: .
woke-args: "*.rst **/*.rst -c https://github.com/canonical-web-and-design/Inclusive-naming/raw/main/config.yml"

linkcheck:
name: Link check
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3

- name: Install the doc framework
working-directory: .
run: |
make install
- name: Run linkchecker
working-directory: .
run: |
make linkcheck
documentation-checks:
uses: canonical/documentation-workflows/.github/workflows/documentation-checks.yaml@main
with:
working-directory: '.'
6 changes: 5 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
/*env*/
.sphinx/venv
.sphinx/venv/
.sphinx/requirements.txt
.sphinx/warnings.txt
.sphinx/.wordlist.dic
.sphinx/.doctrees/
.sphinx/node_modules/
package*.json
_build
.DS_Store
__pycache__
Expand Down
3 changes: 3 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ build:
os: ubuntu-22.04
tools:
python: "3.11"
jobs:
post_checkout:
- python3 build_requirements.py

# Build documentation in the docs/ directory with Sphinx
sphinx:
Expand Down
Loading

0 comments on commit 3926837

Please sign in to comment.