Skip to content

Commit 1b86772

Browse files
committed
Changed docs dir to "src." Updated mkdocs.yml and all documentation. Updated all workflows.
1 parent a6c7678 commit 1b86772

Some content is hidden

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

64 files changed

+1772
-7568
lines changed

.github/CONTRIBUTING.md

Lines changed: 235 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,235 @@
1+
<!-- =========================================================================
2+
Copyright © 2025 Network Pro Strategies (Network Pro™)
3+
SPDX-License-Identifier: CC-BY-4.0 OR GPL-3.0-or-later
4+
This file is part of Network Pro.
5+
========================================================================== -->
6+
7+
<sup>[SPDX-License-Identifier](https://spdx.dev/learn/handling-license-info):
8+
`CC-BY-4.0 OR GPL-3.0-or-later`</sup>
9+
10+
<section id="top">
11+
12+
# Contributing to Network Pro Strategies
13+
14+
</section>
15+
16+
[Network Pro Strategies](https://netwk.pro/) and want to get involved?
17+
Thanks! We're actively looking for folks interested in helping out and there
18+
are plenty of ways you can help!
19+
20+
Please take a moment to review this document in order to make the contribution
21+
process easy and effective for everyone involved.
22+
23+
Following these guidelines helps to communicate that you respect the time of
24+
the developers managing and developing this open source project. In return,
25+
they should reciprocate that respect in addressing your issue or assessing
26+
patches and features.
27+
28+
## Using the issue tracker
29+
30+
The [issue tracker](https://github.com/netwk-pro/netwk-pro.github.io/issues) is
31+
the preferred channel for [bug reports](#bugs), [features requests](#features)
32+
and [submitting pull requests](#pull-requests), but please respect the following
33+
restrictions:
34+
35+
- Please **do not** use the issue tracker for personal support requests (use
36+
[Stack Overflow Teams](https://stack.neteng.pro/), [Discussions](https://discuss.neteng.pro), or [Discord](https://discord.neteng.pro/)).
37+
38+
- Please **do not** derail or troll issues. Keep the discussion on topic and
39+
respect the opinions of others.
40+
41+
<sub>[Back to top](#top)</sub>
42+
43+
<section id="bugs">
44+
45+
## Bug reports
46+
47+
</section>
48+
49+
A bug is a _demonstrable problem_ that is caused by the code in the repository.
50+
Good bug reports are extremely helpful - thank you!
51+
52+
Guidelines for bug reports:
53+
54+
1. **Use the GitHub issue search** &mdash; check if the issue has already been
55+
reported.
56+
57+
2. **Check if the issue has been fixed** &mdash; try to reproduce it using the
58+
latest `master` or development branch in the repository.
59+
60+
3. **Isolate the problem** &mdash; ideally create a [reduced test
61+
case](https://css-tricks.com/reduced-test-cases/) and a live example.
62+
63+
A good bug report shouldn't leave others needing to chase you down for more
64+
information. Please try to be as detailed as possible in your report. What is
65+
your environment? What steps will reproduce the issue? What browser(s) and OS
66+
experience the problem? What would you expect to be the outcome? All these
67+
details will help people to fix any potential bugs.
68+
69+
Example:
70+
71+
> Short and descriptive example bug report title
72+
>
73+
> A summary of the issue and the browser/OS environment in which it occurs. If
74+
> suitable, include the steps required to reproduce the bug.
75+
>
76+
> 1. This is the first step
77+
> 2. This is the second step
78+
> 3. Further steps, etc.
79+
>
80+
> `<url>` - a link to the reduced test case
81+
>
82+
> Any other information you want to share that is relevant to the issue being
83+
> reported. This might include the lines of code that you have identified as
84+
> causing the bug, and potential solutions (and your opinions on their
85+
> merits).
86+
87+
<sub>[Back to top](#top)</sub>
88+
89+
<section id="features">
90+
91+
## Feature requests
92+
93+
</section>
94+
95+
Feature requests are welcome. But take a moment to find out whether your idea
96+
fits with the scope and aims of the project. It's up to _you_ to make a strong
97+
case to convince the project's developers of the merits of this feature. Please
98+
provide as much detail and context as possible.
99+
100+
<sub>[Back to top](#top)</sub>
101+
102+
<section id="pull-requests">
103+
104+
## Pull requests
105+
106+
</section>
107+
108+
Good pull requests - patches, improvements, new features - are a fantastic
109+
help. They should remain focused in scope and avoid containing unrelated
110+
commits.
111+
112+
**Please ask first** before embarking on any significant pull request (e.g.
113+
implementing features, refactoring code, porting to a different language),
114+
otherwise you risk spending a lot of time working on something that the
115+
project's developers might not want to merge into the project.
116+
117+
Please adhere to the coding conventions used throughout a project (indentation,
118+
accurate comments, etc.) and any other requirements (such as test coverage).
119+
120+
Adhering to the following process is the best way to get your work
121+
included in the project:
122+
123+
1. [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your
124+
fork, and configure the remotes:
125+
126+
```bash
127+
# Clone your fork of the repo into the current directory
128+
git clone https://github.com/<your-username>/netwk-pro.github.io.git
129+
# Navigate to the newly cloned directory
130+
cd netwk-pro.github.io
131+
# Assign the original repo to a remote called "upstream"
132+
git remote add upstream https://github.com/netwk-pro/netwk-pro.github.io.git
133+
```
134+
135+
2. If you cloned a while ago, get the latest changes from upstream:
136+
137+
```bash
138+
git checkout master
139+
git pull upstream master
140+
```
141+
142+
3. Create a new topic branch (off the master project development branch) to
143+
contain your feature, change, or fix:
144+
145+
```bash
146+
git checkout -b <topic-branch-name>
147+
```
148+
149+
4. Install locked dependencies:
150+
151+
```bash
152+
npm ci
153+
```
154+
155+
Ensure that your `node` and `npm` versions are compatible with the `engines`
156+
specification in `package.json`.
157+
158+
5. Lint your code locally. As reflected in the `devDependencies`, the following
159+
linting and formatting tools &mdash; or equivalent &mdash; should be used:
160+
161+
- [Prettier](https://prettier.io/)
162+
- [ESLint](https://eslint.org/)
163+
- [markdownlint](https://github.com/DavidAnson/markdownlint) and
164+
[markdownlint2](https://github.com/DavidAnson/markdownlint-cli2)
165+
- [Stylelint](https://stylelint.io/)
166+
167+
6. Commit your changes in logical chunks. Please adhere to these [git commit
168+
message guidelines](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
169+
or your code is unlikely be merged into the main project. Use Git's
170+
[interactive rebase](https://help.github.com/articles/about-git-rebase/)
171+
feature to tidy up your commits before making them public.
172+
173+
7. Locally merge (or rebase) the upstream development branch into your topic branch:
174+
175+
```bash
176+
git pull [--rebase] upstream master
177+
```
178+
179+
8. Update any applicable test cases and run tests:
180+
181+
```bash
182+
npm run test
183+
```
184+
185+
Tests must cover changes and pass to be accepted.
186+
187+
9. Run build and commit changes to build:
188+
189+
```bash
190+
npm run build
191+
git add build/
192+
git commit
193+
```
194+
195+
<!-- markdownlint-disable MD029 -->
196+
197+
10. Push your topic branch up to your fork:
198+
199+
```bash
200+
git push origin <topic-branch-name>
201+
```
202+
203+
11. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
204+
with a clear title and description.
205+
206+
<!-- markdownlint-enable MD029 -->
207+
208+
&nbsp;
209+
210+
**IMPORTANT**: By submitting a patch, you agree to allow the project
211+
owners to license your work under the terms of [CC BY 4.0](https://netwk.pro/license#cc-by) and the [GNU GPL](https://netwk.pro/license#gnu-gpl).
212+
213+
<sub>[Back to top](#top)</sub>
214+
215+
---
216+
217+
<span style="font-size: 12px; font-weight: bold; text-align: center;">
218+
219+
[Home](https://netwk.pro) &nbsp; | &nbsp; [Terms of Use](https://netwk.pro/terms-of-use)
220+
[Privacy Policy](https://netwk.pro/privacy) &nbsp; | &nbsp; [Legal](https://netwk.pro/license)
221+
222+
</span>
223+
224+
&nbsp;
225+
226+
<span style="font-size: 12px; text-align: center;">
227+
228+
Copyright &copy; 2025
229+
**[Network Pro Strategies](https://netwk.pro/)** (Network Pro&trade;)
230+
231+
Network Pro&trade;, the shield logo, and the "Locking Down Netwspan&trade;" slogan are [trademarks](https://netwk.pro/license#trademark) of Network Pro Strategies.
232+
233+
Licensed under **[CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)** and the **[GNU GPL](https://spdx.org/licenses/GPL-3.0-or-later.html)**, as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
234+
235+
</span>

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<!-- =========================================================================
2+
Copyright © 2025 Network Pro Strategies (Network Pro™)
3+
SPDX-License-Identifier: CC-BY-4.0 OR GPL-3.0-or-later
4+
This file is part of Network Pro.
5+
========================================================================== -->
6+
7+
## Types of changes
8+
9+
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
10+
11+
- [ ] Bug fix (non-breaking change which fixes an issue)
12+
- [ ] New feature (non-breaking change which adds functionality)
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
14+
15+
## Description
16+
17+
<!-- What bug does your code fix or what new features are introduced? Please be specific. -->
18+
19+
## Checklist
20+
21+
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
22+
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
23+
24+
- [ ] I have read and followed the guidelines in the **[CONTRIBUTING](https://github.com/netwk-pro/netwk-pro.github.io/blob/master/.github/CONTRIBUTING.md)** document.
25+
- [ ] I've checked to make sure there aren't existing Pull Requests for the same update/change.
26+
- [ ] My code follows the code style of this project.
27+
- [ ] My code has been linted locally prior to submission.
28+
- [ ] My change requires a change to the documentation.
29+
- [ ] I have updated the documentation accordingly.
30+
- [ ] Where applicable, I have added tests to cover my changes.
31+
- [ ] All new and existing tests passed.
32+
33+
Pull requests should be thought of as a conversation. There will be some back and forth when trying to get code merged into this or any other project.
34+
35+
With all but the simplest changes, you can and should expect that the maintainers of the project will request changes to your code.
36+
37+
Please be aware of that and check in after you open your PR in order to get your code merged in cleanly.
38+
39+
Thank you!

.github/workflows/auto-assign.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ jobs:
2323
pull-requests: write
2424

2525
steps:
26-
- name: "Auto-assign issue or PR"
26+
- name: Auto-assign issue or PR
2727
uses: pozil/auto-assign-issue@v2
2828
with:
2929
repo-token: ${{ secrets.SD311 }}

.github/workflows/build-and-deploy.yml

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ jobs:
2727
runs-on: ubuntu-24.04
2828
# Continue workflow even if this job fails due to inability to find and/or check CodeQL workflow
2929
continue-on-error: true
30+
3031
steps:
3132
- name: Checkout repository
3233
uses: actions/checkout@v4
@@ -54,6 +55,7 @@ jobs:
5455
build:
5556
needs: check-codeql
5657
runs-on: ubuntu-24.04
58+
5759
steps:
5860
- name: Checkout repository
5961
uses: actions/checkout@v4
@@ -64,20 +66,11 @@ jobs:
6466
node-version: lts/*
6567
check-latest: true
6668
cache: npm
69+
cache-dependency-path: package-lock.json
6770

6871
- name: Setup Pages
6972
uses: actions/configure-pages@v5
7073

71-
- name: Cache Node.js modules
72-
uses: actions/cache@v4
73-
with:
74-
path: ~/.npm
75-
key: ${{ runner.os }}-node-lts-${{ hashFiles('package-lock.json', 'package.json', '.npmrc') }}
76-
restore-keys: |
77-
${{ runner.os }}-node-lts-build-
78-
${{ runner.os }}-node-lts-
79-
${{ runner.os }}-
80-
8174
- name: Install Node.js dependencies
8275
run: npm ci
8376

@@ -89,9 +82,9 @@ jobs:
8982

9083
- name: Install MkDocs and plugins
9184
run: |
92-
pip install mkdocs mkdocs-material mkdocs-material-extensions mkdocs-get-deps mkdocs-rss-plugin
85+
pip install mkdocs mkdocs-material mkdocs-material-extensions mkdocs-get-deps
9386
94-
# Strict mode temporarily disabled as workaround for mkdocs-material
87+
# Strict mode disabled as workaround for mkdocs-material
9588
- name: Build MkDocs documentation
9689
run: mkdocs build
9790
# MkDocs Integration Ends

.github/workflows/dependency-review.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ jobs:
1313
dependency-review:
1414
runs-on: ubuntu-24.04
1515
steps:
16-
- name: "Checkout Repository"
16+
- name: Checkout Repository
1717
uses: actions/checkout@v4
1818

19-
- name: "Dependency Review"
19+
- name: Dependency Review
2020
uses: actions/dependency-review-action@v4

0 commit comments

Comments
 (0)