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

WIP: README #94

Merged
merged 2 commits into from Mar 12, 2019

Conversation

Projects
None yet
4 participants
@mster
Copy link
Collaborator

mster commented Mar 5, 2019

Followed nscm/README.md as a guideline.

(Moved from google docs)

Feel free to leave comments/changes/addition on the doc, or as a comment on this PR.


TODO:

  • License & Copyright segment
  • Installation instructions
  • Reflect go/no go on CI Token implementation
  • Update example output to release build (this will be done last)

@mster mster referenced this pull request Mar 5, 2019

Closed

documentation #48

@Fishrock123 Fishrock123 requested review from Fishrock123 and Raynos Mar 5, 2019

@mster mster force-pushed the mster/docs branch from 318762d to 10f7bda Mar 5, 2019

@Fishrock123
Copy link
Contributor

Fishrock123 left a comment

Some general things:

  • The usage section should be almost completely collapsed, mentioning only the usage header and the signing, report, and details commands.
  • Signin section should be condensed.

The other subsections should probably be in a different order:

  • report
  • details
  • whitelist
  • A brief note on the config command, mentioning ncm config --help.
    • People should ordinarily not have to touch the config.

This will also need a slight update to account for #95

Show resolved Hide resolved README.md Outdated
Show resolved Hide resolved README.md Outdated
Show resolved Hide resolved README.md Outdated
Show resolved Hide resolved README.md Outdated
Show resolved Hide resolved README.md Outdated
Show resolved Hide resolved README.md Outdated
Show resolved Hide resolved README.md Outdated

@mster mster force-pushed the mster/docs branch from d3ad383 to 1a899a1 Mar 6, 2019

Show resolved Hide resolved README.md Outdated
Show resolved Hide resolved README.md Outdated
Show resolved Hide resolved README.md Outdated

@mster mster force-pushed the mster/docs branch from e7f960c to 6ff6030 Mar 7, 2019

@Fishrock123
Copy link
Contributor

Fishrock123 left a comment

Shaping up... just a couple more things.

Show resolved Hide resolved README.md Outdated
Show resolved Hide resolved README.md Outdated
Show resolved Hide resolved README.md

@mster mster force-pushed the mster/docs branch from 00c12d9 to b631b6f Mar 8, 2019

|➔ Run `ncm report --filter=compliance` for a list
─────────────────────────────────────────────────────────────────────────────────────────────────
null

This comment has been minimized.

@mster

mster Mar 8, 2019

Author Collaborator

Is this okay? @Fishrock123

(null whenever filtering compliance, security, etc)

This comment has been minimized.

@Fishrock123

Fishrock123 Mar 12, 2019

Contributor

@mster This should be fixed - can you update once more?

@nodesource nodesource deleted a comment from mster Mar 12, 2019

package: add repo
Just the short form for now.
@Fishrock123

This comment has been minimized.

Copy link
Contributor

Fishrock123 commented Mar 12, 2019

I have to merge this.

@Fishrock123 Fishrock123 force-pushed the mster/docs branch from b631b6f to 086716f Mar 12, 2019

@Fishrock123 Fishrock123 merged commit 086716f into master Mar 12, 2019

1 check passed

CodeBuild Build was a success.
Details

@Jazneil Jazneil added this to the Sprint 10 (2/26 - 3/18) milestone Mar 15, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.