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

Documentation and release prep #41

Merged
merged 24 commits into from Jan 15, 2021
Merged

Documentation and release prep #41

merged 24 commits into from Jan 15, 2021

Conversation

MartyEwings
Copy link
Collaborator

resolves #6

Copy link
Contributor

@jarretlavallee jarretlavallee left a comment

Choose a reason for hiding this comment

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

Looks pretty good. I put in a few nit picks. You may also want to generate the REFERENCE.md. The code headers may need to be updated to account for it.

pdk bundle exec rake strings:generate:reference

The REFERENCE.md will populate the reference page in the forge and generate docs around the code from the header comments with `puppet-strings.

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
RSAN Development automation moved this from To Do to In Progress Jan 14, 2021
MartyEwings and others added 2 commits January 14, 2021 16:03
Co-authored-by: Jarret Lavallee <jarretlavallee@users.noreply.github.com>
Co-authored-by: Jarret Lavallee <jarretlavallee@users.noreply.github.com>
@jarretlavallee
Copy link
Contributor

We should document resource requirements so the customer knows what size of a machine needs to be deployed for RSAN.

@jarretlavallee
Copy link
Contributor

Also, the agent OS needs to be the same OS as the master or it cannot deploy the client tools automatically.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@jarretlavallee jarretlavallee left a comment

Choose a reason for hiding this comment

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

Minor formatting updates

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 Show resolved Hide resolved
Co-authored-by: Jarret Lavallee <jarretlavallee@users.noreply.github.com>
@MartyEwings
Copy link
Collaborator Author

We should document resource requirements so the customer knows what size of a machine needs to be deployed for RSAN.

iv been testing on m1 medium, and that's probably as small as you want any Puppet agent, ill set that as minimum

MartyEwings and others added 2 commits January 15, 2021 14:27
Co-authored-by: Jarret Lavallee <jarretlavallee@users.noreply.github.com>
MartyEwings and others added 7 commits January 15, 2021 14:28
Co-authored-by: Jarret Lavallee <jarretlavallee@users.noreply.github.com>
Co-authored-by: Jarret Lavallee <jarretlavallee@users.noreply.github.com>
Co-authored-by: Jarret Lavallee <jarretlavallee@users.noreply.github.com>
Co-authored-by: Jarret Lavallee <jarretlavallee@users.noreply.github.com>
Co-authored-by: Jarret Lavallee <jarretlavallee@users.noreply.github.com>
Co-authored-by: Jarret Lavallee <jarretlavallee@users.noreply.github.com>
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
MartyEwings and others added 3 commits January 15, 2021 15:33
Co-authored-by: Jarret Lavallee <jarretlavallee@users.noreply.github.com>
Copy link
Contributor

@jarretlavallee jarretlavallee left a comment

Choose a reason for hiding this comment

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

LGTM ship it

@MartyEwings MartyEwings merged commit 58e5085 into main Jan 15, 2021
RSAN Development automation moved this from In Progress to complete Jan 15, 2021
@MartyEwings MartyEwings deleted the Documentation branch April 29, 2021 12:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Development

Successfully merging this pull request may close these issues.

Readme / Metadata module misc
2 participants