Skip to content

Commit 158ddc0

Browse files
Porting docs back to porch repo (#387)
* porting docs back to porch repo * removing non porch images * removing wordlist + refactoring config.toml to porch wording * removing config files * removing feature background image * fixed project links and porcifyed some of the package.json * Update docs/package.json * Update docs/config.toml * Update docs/config.toml * Update docs/package.json * Update docs/config.toml --------- Co-authored-by: Fiachra Corcoran <fiachra.corcoran@est.tech>
1 parent a0f2385 commit 158ddc0

154 files changed

Lines changed: 13913 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/.linkspector.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
dirs:
2+
- .
3+
useGitIgnore: true
4+
5+
aliveStatusCodes:
6+
- 200
7+
- 201
8+
- 204
9+
- 302
10+
- 304
11+
12+
ignorePatterns:
13+
- pattern: "^http://localhost.*$"
14+
- pattern: "^http://HOSTNAME:PORT.*$"
15+
- pattern: "172\\.18\\.255\\.200"
16+
- pattern: "https://\\*kpt\\*\\.dev/"
17+
- pattern: "https://my-gitlab\\.com/joe\\.bloggs/blueprints\\.git"
18+
- pattern: "http://172\\.18\\.0\\.200:3000/nephio/"
19+
- pattern: "https://www\\.gnu\\.org/"
20+
- pattern: "https://stackoverflow.com/questions/.*"
21+
- pattern: "https://www.npmjs.com/.*"
22+
- pattern: "https://travis-ci.org/.*"
23+
- pattern: "https://containerlab\\.dev.*"
24+
- pattern: "https://docs\\.google\\.com/.*"
25+
- pattern: "https://github\\.com/nephio-project/porch/releases/download/.*/porchctl_.*_linux_amd64\\.tar\\.gz"
26+
- pattern: "https://kubernetes\\.io/.*"
27+
- pattern: "https://github\\.com/nephio-project/porch/releases/download/v\\{\\{"
28+
29+
30+
31+
replacementPatterns:
32+
- pattern: ".md#.*$"
33+
replacement: ".md"

docs/.spellcheck.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
# SPDX-license-identifier: CC-BY-4.0
3+
# Copyright contributors to the Nephio Project
4+
5+
matrix:
6+
- name: markdown
7+
dictionary:
8+
wordlists:
9+
- .wordlist.txt
10+
pipeline:
11+
- pyspelling.filters.markdown:
12+
sources:
13+
- '**/*.md'
14+
aspell:
15+
ignore-case: true

docs/.textlintrc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"rules": {
3+
"terminology": {
4+
"defaultTerms": true,
5+
"terms": [
6+
["repo\\b", "repository"]
7+
]
8+
}
9+
}
10+
}

docs/.vale.ini

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Vale is an open-source, command-line tool that brings your editorial style guide to life.
2+
# source: https://vale.sh
3+
4+
# Styles are stored in the .vale folder
5+
StylesPath = .vale
6+
7+
# Configured styles can be downloaded with the command: vale sync
8+
Packages = proselint, alex, Hugo
9+
# Alert suggestions, warnings and alerts
10+
MinAlertLevel = suggestion
11+
12+
# Configure a dictionary specific to Nephio
13+
Vocab = Nephio
14+
SkippedScopes = iframe
15+
16+
[*.md]
17+
BasedOnStyles = Vale, proselint, alex
18+
19+
# based on https://github.com/errata-ai/Hugo/blob/main/Hugo/.vale.ini
20+
# Exclude `{{< ... >}}`, `{{% ... %}}`, [Who]({{< ... >}})
21+
TokenIgnores = ({{[%<] .* [%>]}}.*?{{[%<] ?/.* [%>]}}), \
22+
(\[.+\]\({{< .+ >}}\)), \
23+
[^\S\r\n]({{[%<] \w+ .+ [%>]}})\s, \
24+
[^\S\r\n]({{[%<](?:/\*) .* (?:\*/)[%>]}})\s
25+
26+
# Exclude `{{< myshortcode `This is some <b>HTML</b>, ... >}}`
27+
BlockIgnores = (?sm)^({{[%<] \w+ [^{]*?\s[%>]}})\n$, \
28+
(?s) *({{< highlight [^>]* ?>}}.*?{{< ?/ ?highlight >}})
29+

0 commit comments

Comments
 (0)