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

(PIE-551) Docs Update #115

Merged
merged 2 commits into from
Apr 7, 2021
Merged

(PIE-551) Docs Update #115

merged 2 commits into from
Apr 7, 2021

Conversation

coreymbe
Copy link
Contributor

Summary

Updates to README.md to address PIE-551 and potentially PIE-351.

Detailed Description

Moved Custom Installation section to README.md. Added a paragraph to point to the Puppet Alert Actions app and repo. Additional updates made to address markdown syntax, remove harmful terminology, PE console updates, and grammatical errors.

Checklist

[ ] Draft PR?
[x] Ensure README is updated
[x] Any changes to existing documentation
[x] Anything new added
[x] Link to external Puppet documentation
[ ] Tags
[ ] Unit Tests
[ ] Acceptance Tests
[x] PR title is "(Ticket|Maint) Short Description"
[ ] Commit title matches PR title

@coreymbe coreymbe requested a review from a team as a code owner March 18, 2021 18:09
@CLAassistant
Copy link

CLAassistant commented Mar 18, 2021

CLA assistant check
All committers have signed the CLA.

@Magisus
Copy link

Magisus commented Mar 18, 2021

Is there a place we could call out what error you might see -- Could not find terminus splunk_hec for indirection facts -- if your umask is set wrong?

@coreymbe
Copy link
Contributor Author

@Magisus :: After chatting w/ Bill, there are a few things I need to tweak before this gets merged. So I should be able to find a place to add that error.

@Magisus
Copy link

Magisus commented Apr 5, 2021

I still think it would be good if we could call out the error that happens when umask is not set correctly. Otherwise the connection between the (still somewhat buried) recommendation and the error that customers are seeing is not very clear.

README.md Show resolved Hide resolved
@coreymbe
Copy link
Contributor Author

coreymbe commented Apr 6, 2021

@bmjen @Magisus :: Sorry about that, the latest commits were to better organize the previous commits I had. Still plan to add the error to the Custom Installation section. 👍

Magisus
Magisus previously approved these changes Apr 6, 2021
README.md Outdated Show resolved Hide resolved
Copy link

@Magisus Magisus left a comment

Choose a reason for hiding this comment

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

LGTM!

@bmjen bmjen merged commit 701945e into puppetlabs:main Apr 7, 2021
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.

4 participants