Skip to content

Commit 9a883c0

Browse files
BrianSiposBrianSipos
committed
Initial public release of docs
0 parents  commit 9a883c0

86 files changed

Lines changed: 2808 additions & 0 deletions

Some content is hidden

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

‎.gitignore‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# editor files
2+
*~
3+
.#*
4+
5+
# generated files
6+
build
7+
*/docinfo.xml
8+
public

‎.gitlab-ci.yml‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
##
2+
## Copyright (c) 2023 The Johns Hopkins University Applied Physics
3+
## Laboratory LLC.
4+
##
5+
## This file is part of the Asynchronous Network Managment System (ANMS).
6+
##
7+
## Licensed under the Apache License, Version 2.0 (the "License");
8+
## you may not use this file except in compliance with the License.
9+
## You may obtain a copy of the License at
10+
## http://www.apache.org/licenses/LICENSE-2.0
11+
## Unless required by applicable law or agreed to in writing, software
12+
## distributed under the License is distributed on an "AS IS" BASIS,
13+
## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
## See the License for the specific language governing permissions and
15+
## limitations under the License.
16+
##
17+
## This work was performed for the Jet Propulsion Laboratory, California
18+
## Institute of Technology, sponsored by the United States Government under
19+
## the prime contract 80NM0018D0004 between the Caltech and NASA under
20+
## subcontract 1658085.
21+
##
22+
default:
23+
# Unrestricted build environment
24+
image: docker-remote.artifactory.jhuapl.edu/ubuntu:22.04
25+
26+
include:
27+
# Run pipeline only on branches, not MRs
28+
- template: 'Workflows/Branch-Pipelines.gitlab-ci.yml'
29+
# auto-static-analysis
30+
- template: Security/SAST.gitlab-ci.yml
31+
- template: Code-Quality.gitlab-ci.yml
32+
33+
variables:
34+
GIT_SUBMODULE_STRATEGY: recursive
35+
DEBIAN_FRONTEND: "noninteractive"
36+
# for Python/PIP
37+
PIP_CERT: /etc/ssl/certs/ca-certificates.crt
38+
PIP_DEFAULT_TIMEOUT: "300"
39+
# for Ruby/bolt
40+
SSL_CERT_FILE: /etc/ssl/certs/ca-certificates.crt
41+
42+
43+
stages:
44+
- build
45+
- test
46+
- deploy
47+
48+
.prep-install-ca: &prep-install-ca |
49+
apt-get update && apt-get install -y ca-certificates curl
50+
mkdir -p /usr/local/share/ca-certificates
51+
curl -svL http://apllinuxdepot.jhuapl.edu/linux/APL-root-cert/JHUAPL-MS-Root-CA-05-21-2038-B64-text.cer -o /usr/local/share/ca-certificates/JHUAPL-MS-Root-CA-05-21-2038-B64-text.crt
52+
update-ca-certificates
53+
54+
55+
docs:
56+
stage: build
57+
needs: []
58+
before_script:
59+
- *prep-install-ca
60+
- apt-get update && apt-get install -y cmake make coreutils ruby asciidoctor graphviz inkscape dblatex docbook-xsl-ns xsltproc xmlstarlet
61+
- gem install asciidoctor-diagram
62+
script:
63+
- DESTDIR=public ./build.sh
64+
artifacts:
65+
paths:
66+
- "public"
67+
68+
# Job name to use Gitlab Pages feature
69+
pages:
70+
stage: deploy
71+
rules:
72+
- if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
73+
needs:
74+
- job: docs
75+
artifacts: true
76+
script:
77+
- "true" # Just a copy from job:docs
78+
artifacts:
79+
paths:
80+
- "public"

‎CMakeLists.txt‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
#[[
2+
Copyright (c) 2023 The Johns Hopkins University Applied Physics
3+
Laboratory LLC.
4+
5+
This file is part of the Asynchronous Network Managment System (ANMS).
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
http://www.apache.org/licenses/LICENSE-2.0
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific language governing permissions and
15+
limitations under the License.
16+
17+
This work was performed for the Jet Propulsion Laboratory, California
18+
Institute of Technology, sponsored by the United States Government under
19+
the prime contract 80NM0018D0004 between the Caltech and NASA under
20+
subcontract 1658085.
21+
]]
22+
cmake_minimum_required(VERSION 3.16)
23+
# No compiler checks
24+
project(anms-docs LANGUAGES )
25+
set(CMAKE_INSTALL_PREFIX "")
26+
27+
add_subdirectory(user-guide)
28+
add_subdirectory(product-guide)
29+
30+
install(
31+
FILES index.html
32+
DESTINATION .
33+
)

‎CODE_OF_CONDUCT.md‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Code of Conduct - Asynchronous Network Management System (ANMS)
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to make participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to a positive environment for our
15+
community include:
16+
17+
* Demonstrating empathy and kindness toward other people
18+
* Being respectful of differing opinions, viewpoints, and experiences
19+
* Giving and gracefully accepting constructive feedback
20+
* Accepting responsibility and apologizing to those affected by our mistakes,
21+
and learning from the experience
22+
* Focusing on what is best not just for us as individuals, but for the
23+
overall community
24+
25+
Examples of unacceptable behavior include:
26+
27+
* The use of sexualized language or imagery, and sexual attention or
28+
advances
29+
* Trolling, insulting or derogatory comments, and personal or political attacks
30+
* Public or private harassment
31+
* Publishing others' private information, such as a physical or email
32+
address, without their explicit permission
33+
* Other conduct which could reasonably be considered inappropriate in a
34+
professional setting
35+
36+
## Our Responsibilities
37+
38+
Project maintainers are responsible for clarifying and enforcing our standards of
39+
acceptable behavior and will take appropriate and fair corrective action in
40+
response to any instances of unacceptable behavior.
41+
42+
Project maintainers have the right and responsibility to remove, edit, or reject
43+
comments, commits, code, wiki edits, issues, and other contributions that are
44+
not aligned to this Code of Conduct, or to ban
45+
temporarily or permanently any contributor for other behaviors that they deem
46+
inappropriate, threatening, offensive, or harmful.
47+
48+
## Scope
49+
50+
This Code of Conduct applies within all community spaces, and also applies when
51+
an individual is officially representing the community in public spaces.
52+
Examples of representing our community include using an official e-mail address,
53+
posting via an official social media account, or acting as an appointed
54+
representative at an online or offline event.
55+
56+
## Enforcement
57+
58+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
59+
reported to the community leaders responsible for enforcement at <dtnma-support@jhuapl.edu>.
60+
All complaints will be reviewed and investigated promptly and fairly.
61+
62+
All community leaders are obligated to respect the privacy and security of the
63+
reporter of any incident.
64+
65+
## Attribution
66+
67+
This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org/), version
68+
[1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md) and
69+
[2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md),
70+
and was generated by [contributing-gen](https://github.com/bttger/contributing-gen).

‎CONTRIBUTING.md‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
<!-- omit in toc -->
2+
# Contributing to Asynchronous Network Management System (ANMS)
3+
4+
First off, thanks for taking the time to contribute!
5+
6+
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions.
7+
8+
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
9+
> - Star the project
10+
> - Tweet about it
11+
> - Refer this project in your project's readme
12+
> - Mention the project at local meetups and tell your friends/colleagues
13+
14+
<!-- omit in toc -->
15+
## Table of Contents
16+
17+
- [Code of Conduct](#code-of-conduct)
18+
- [I Have a Question](#i-have-a-question)
19+
- [I Want To Contribute](#i-want-to-contribute)
20+
- [Reporting Bugs](#reporting-bugs)
21+
- [Suggesting Enhancements](#suggesting-enhancements)
22+
- [Your First Code Contribution](#your-first-code-contribution)
23+
- [Improving The Documentation](#improving-the-documentation)
24+
- [Styleguides](#styleguides)
25+
- [Commit Messages](#commit-messages)
26+
- [Join The Project Team](#join-the-project-team)
27+
28+
29+
## Code of Conduct
30+
31+
This project and everyone participating in it is governed by the [Asynchronous Network Management System (ANMS) Code of Conduct](CODE_OF_CONDUCT.md).
32+
By participating, you are expected to uphold this code.
33+
Please report unacceptable behavior to <dtnma-support@jhuapl.edu>.
34+
35+
36+
## I Have a Question
37+
38+
> If you want to ask a question, we assume that you have read the available [Documentation](https://nasa-ammos.github.io/anms-docs/).
39+
40+
Before you ask a question, it is best to search for existing [Issues](https://github.com/nasa-ammos/anms-docs/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
41+
42+
If you then still feel the need to ask a question and need clarification, we recommend the following:
43+
44+
- Open an [Issue](https://github.com/nasa-ammos/anms-docs/issues/new).
45+
- Provide as much context as you can about what you're running into.
46+
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
47+
48+
We will then take care of the issue as soon as possible.
49+
50+
## I Want To Contribute
51+
52+
> ### Legal Notice <!-- omit in toc -->
53+
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
54+
55+
### Reporting Bugs
56+
57+
<!-- omit in toc -->
58+
#### Before Submitting a Bug Report
59+
60+
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
61+
62+
- Make sure that you are using the latest version.
63+
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://nasa-ammos.github.io/anms-docs/). If you are looking for support, you might want to check [this section](#i-have-a-question)).
64+
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/nasa-ammos/anms-docs/issues?q=label%3Abug).
65+
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
66+
- Collect information about the bug:
67+
- Stack trace (Traceback)
68+
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
69+
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
70+
- Possibly your input and the output
71+
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
72+
73+
<!-- omit in toc -->
74+
#### How Do I Submit a Good Bug Report?
75+
76+
> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <dtnma-support@jhuapl.edu>.
77+
78+
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
79+
80+
- Open an [Issue](https://github.com/nasa-ammos/anms-docs/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
81+
- Explain the behavior you would expect and the actual behavior.
82+
- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
83+
- Provide the information you collected in the previous section.
84+
85+
Once it's filed:
86+
87+
- The project team will label the issue accordingly.
88+
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
89+
- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
90+
91+
92+
### Suggesting Enhancements
93+
94+
This section guides you through submitting an enhancement suggestion for Asynchronous Network Management System (ANMS), **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
95+
96+
<!-- omit in toc -->
97+
#### Before Submitting an Enhancement
98+
99+
- Make sure that you are using the latest version.
100+
- Read the [documentation](https://nasa-ammos.github.io/anms-docs/) carefully and find out if the functionality is already covered, maybe by an individual configuration.
101+
- Perform a [search](https://github.com/nasa-ammos/anms-docs/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
102+
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
103+
104+
<!-- omit in toc -->
105+
#### How Do I Submit a Good Enhancement Suggestion?
106+
107+
Enhancement suggestions are tracked as [GitHub issues](https://github.com/nasa-ammos/anms-docs/issues).
108+
109+
- Use a **clear and descriptive title** for the issue to identify the suggestion.
110+
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
111+
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
112+
- **Explain why this enhancement would be useful** to most Asynchronous Network Management System (ANMS) users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
113+
114+
### Your First Code Contribution
115+
116+
The associated [README](README.md) includes brief instructions on building, testing, and running the ACE CLI tool.
117+
118+
### Improving The Documentation
119+
120+
Updates to documentation, both in-source Sphinx docstrings and out-of-source explanations or procedures, is welcome.
121+
If a documentation issue is observed but a proposed update is not available, an issue ticket can be written.
122+
123+
Additionally, comments on and updates to the ANMS Product Guide and User Guide (hosted in a different [ANMS Docs](https://github.com/nasa-ammos/anms-docs) repository) are welcome.
124+
125+
## Styleguides
126+
127+
The ACE library follows [PEP 8](https://peps.python.org/pep-0008/) style and formatting for all Python source, and inline documentation follows the [Sphinx docstring](https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html) formatting.
128+
129+
Commit messages should be short but descriptive, and reference specific issue tickets when resolving them.
130+
131+
<!-- omit in toc -->
132+
## Attribution
133+
This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!

0 commit comments

Comments
 (0)