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.

Sign up for GitHub

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

Jump to bottom

Local Developer Installation Docs Are Outdated #1283

Closed
aj-stein-nist opened this issue May 20, 2022 · 0 comments · Fixed by #1307 or #1309
Closed

Local Developer Installation Docs Are Outdated #1283

aj-stein-nist opened this issue May 20, 2022 · 0 comments · Fixed by #1307 or #1309
Assignees
@aj-stein-nist
Labels
bug Scope: Documentation This issue relates to OSCAL documentation.
Milestone
v1.0.5

Comments

@aj-stein-nist
Copy link
Contributor

Describe the bug

As an OSCAL tool developer, to understand how to set up a local environment and contribute feedback and docs and code enhancements back to the project, I would like accurate docs for local installation.

Who is the bug affecting?

Tool developers configuring local dev environment on their workstation.

What is affected by this bug?

Installation and configuration of the tools.

When does this occur?

Consistently.

How do we replicate the issue?

  1. Read docs.
  2. Observe inconsistencies and issues with docs.

Dave noticed commands like npm install are running package install package by package, not using the updated package-lock.json manifest. Check and fix nits like this.

Expected behavior (i.e. solution)

Docs are correct and current, inline with the updated build tools and processes.

Other Comments

{Add any other context about the problem here.}
@aj-stein-nist aj-stein-nist added bug Scope: Documentation This issue relates to OSCAL documentation. labels May 20, 2022
@david-waltermire david-waltermire added this to the OSCAL 1.0.5 milestone May 24, 2022
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Jun 13, 2022
@aj-stein-nist
[skip ci] Update docs for dev env setup per usnistgov#1283.
500bd25
@aj-stein-nist aj-stein-nist mentioned this issue Jun 13, 2022
Merged
6 tasks
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Jun 13, 2022
@aj-stein-nist
[skip ci] Update docs for dev env setup per usnistgov#1283.
c3d6b27
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Jun 13, 2022
@aj-stein-nist
[skip ci] Update docs for dev env setup per usnistgov#1283.
e0494f2
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Jun 13, 2022
@aj-stein-nist
[skip ci] Update docs for dev env setup per usnistgov#1283.
38c52ab
david-waltermire pushed a commit that referenced this issue Jun 13, 2022
@aj-stein-nist
[skip ci] Update docs for dev env setup per #1283. (#1307)
32b599b
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Jun 13, 2022
@aj-stein-nist
[skip ci] Update docs for dev env setup per usnistgov#1283.
b78b10b
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Jun 13, 2022
@aj-stein-nist
[skip ci] Update docs for dev env setup per usnistgov#1283.
aba804f
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Jun 13, 2022
@aj-stein-nist
[skip ci] Update docs for dev env setup per usnistgov#1283.
16348cd
@aj-stein-nist aj-stein-nist mentioned this issue Jun 13, 2022
Merged
5 tasks
@aj-stein-nist aj-stein-nist linked a pull request Jun 13, 2022 that will close this issue
[skip ci] Update docs for dev env setup per usnistgov/OSCAL#1283. #1309
Merged
5 tasks
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Jun 14, 2022
@aj-stein-nist
[skip ci] Update docs for dev env setup per usnistgov#1283. (usnistgo…
10fc5b9 
…v#1307)
david-waltermire pushed a commit that referenced this issue Jun 16, 2022
@aj-stein-nist
[skip ci] Update docs for dev env setup per #1283. (#1309)
e6ba85b
david-waltermire pushed a commit that referenced this issue Jun 24, 2022
@aj-stein-nist @david-waltermire
[skip ci] Update docs for dev env setup per #1283. (#1307)
2fc7408
david-waltermire pushed a commit that referenced this issue Jun 24, 2022
@aj-stein-nist @david-waltermire
[skip ci] Update docs for dev env setup per #1283. (#1309)
9889ff2
david-waltermire pushed a commit that referenced this issue Jul 13, 2022
@aj-stein-nist @david-waltermire
[skip ci] Update docs for dev env setup per #1283. (#1307)
5564d28
david-waltermire pushed a commit that referenced this issue Jul 13, 2022
@aj-stein-nist @david-waltermire
[skip ci] Update docs for dev env setup per #1283. (#1309)
4a4a2c5
david-waltermire pushed a commit that referenced this issue Aug 23, 2022
@aj-stein-nist @david-waltermire
[skip ci] Update docs for dev env setup per #1283. (#1307)
f89f8c5
david-waltermire pushed a commit that referenced this issue Aug 23, 2022
@aj-stein-nist @david-waltermire
[skip ci] Update docs for dev env setup per #1283. (#1309)
320c607
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@aj-stein-nist aj-stein-nist

Labels
bug Scope: Documentation This issue relates to OSCAL documentation.
Projects
None yet
Milestone
v1.0.5
2 participants
@david-waltermire @aj-stein-nist