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.

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

Added artifact usage + corrected dead links #1865

Merged
merged 2 commits into from
Jul 26, 2023
Merged

Added artifact usage + corrected dead links #1865

merged 2 commits into from
Jul 26, 2023

Conversation

nikitawootten-nist
Copy link
Contributor

@nikitawootten-nist nikitawootten-nist commented Jul 26, 2023

Committer Notes

  • Added usage instructions for JSON Schema, XSD, and converter artifacts.
  • Corrected dead links
  • Small adjustment to the versioning and branching document

All Submissions:

By submitting a pull request, you are agreeing to provide this contribution under the CC0 1.0 Universal public domain dedication.

(For reviewers: The wiki has guidance on code review and overall issue review for completeness.)

Changes to Core Features:

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your core changes, as applicable?
  • Have you included examples of how to use your new feature(s)?
  • Have you updated all OSCAL website and readme documentation affected by the changes you made? Changes to the OSCAL website can be made in the docs/content directory of your branch.

@nikitawootten-nist
Copy link
Contributor Author

@aj-stein-nist should this PR target main and then be pushed to develop or the other way around?

JustKuzya
JustKuzya previously approved these changes Jul 26, 2023
Copy link
Contributor

@JustKuzya JustKuzya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like a lot of simple changes, though I'm not sure if link validator can validate ./ and ../../../ paths. Can it?

@aj-stein-nist
Copy link
Contributor

@aj-stein-nist should this PR target main and then be pushed to develop or the other way around?

I assume we will make all changes and prep for a release (so develop-> release tag -> main), so develop now we don't have the site content in here, correct?

@nikitawootten-nist nikitawootten-nist changed the base branch from main to develop July 26, 2023 16:54
@aj-stein-nist
Copy link
Contributor

Seems like a lot of simple changes, though I'm not sure if link validator can validate ./ and ../../../ paths. Can it?

Pull down the branch, go into the build directory and run link checking like so. (But this is also run by the CI/CD, but if you want to know how to validate yourself): git checkout remotename branch; pushd build; make linkcheck; popd;.

Copy link
Contributor

@aj-stein-nist aj-stein-nist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wait hold up, I am glad Dmitry asked there is some issue with how linkcheck is run locally and it fails, is it the same in CI/CD?

@nikitawootten-nist
Copy link
Contributor Author

Yeah I'm getting a traceback:

/Users/naw2/Documents/repos/oscal/OSCAL/build/node_modules/async/dist/async.js:324
            if (fn === null) throw new Error("Callback was already called.");
                             ^

Error: Callback was already called.
    at /Users/naw2/Documents/repos/oscal/OSCAL/build/node_modules/async/dist/async.js:324:36
    at /Users/naw2/Documents/repos/oscal/OSCAL/build/node_modules/async/dist/async.js:248:17
    at /Users/naw2/Documents/repos/oscal/OSCAL/build/node_modules/markdown-link-check/index.js:129:13
    at /Users/naw2/Documents/repos/oscal/OSCAL/build/node_modules/link-check/lib/proto/http.js:117:21
    at done (/Users/naw2/Documents/repos/oscal/OSCAL/build/node_modules/needle/lib/needle.js:463:14)
    at PassThrough.<anonymous> (/Users/naw2/Documents/repos/oscal/OSCAL/build/node_modules/needle/lib/needle.js:717:9)
    at PassThrough.emit (node:events:523:35)
    at endReadableNT (node:internal/streams/readable:1367:12)
    at process.processTicksAndRejections (node:internal/process/task_queues:82:21)

Node.js v20.3.1
make: *** [Makefile:125: generated/mlc_report.log] Error 1

But this doesn't happen in CI? Weird

Copy link
Contributor

@aj-stein-nist aj-stein-nist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I apologize. I had not properly pulled down the correct updated branch locally as I was replying to @JustKuzya. 🤦 This is good and valid, I go back to approving (it's a little slower locally than I recalled).

@aj-stein-nist aj-stein-nist merged commit 1f45b52 into usnistgov:develop Jul 26, 2023
1 check passed
@aj-stein-nist
Copy link
Contributor

Yeah I'm getting a traceback:
...
But this doesn't happen in CI? Weird

I only get that when link check fails, but on clean branches I don't get the stack trace, weird to me too. I guess we can review and reconsider the issue, reassessing markdown-link-checker if we'd like.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants