Skip to content

Commit 06ca409

Browse files
Update README.markdown
Made minor tweaks in the text
1 parent 778b2f6 commit 06ca409

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.markdown

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,38 @@
11
# Puppet Docs
22

3-
Curated documentation and issue tracker for Puppet.
3+
Curated documentation and issue tracker for Puppet
44

55
## Where is everything?
66

77
Most of our documentation has been moved out of this repository. This repo contains:
88
* Some of our older, unmaintained documentation, which is deprecated and may be removed from this repo without further notice. For archived docs for unmaintained, unsupported versions of Puppet, see the [Puppet docs archive](https://github.com/puppetlabs/docs-archive).
99
* Reference documentation generated from code. This reference documentation is then rendered into HTML and included in the Puppet docs website.
10-
* The issue tracker allowing you to suggest improvements to puppet.com/docs
10+
* The issue tracker, which community members can use to suggest improvements to puppet.com/docs.
1111

1212
As of Puppet 5.5, Puppet docs were migrated into the DITA XML format and have been maintained in a CMS. We removed each migrated page from this repository, so that the old content wasn't accidentally published.
1313

1414
As of Facter 3.12, the Facter docs were migrated to DITA and organized as part of the Puppet doc set. Updates to 3.12 (and later) should be made in DITA, not in this repo. The generated `core_facts.md` file is still this repository, but has moved to the `puppet/x.y` folder instead of `facter/x.y`.
1515

16-
## Reporting Issues
16+
## Reporting issues
1717

18-
This repository will allow public community members to suggest documentation improvements.
19-
The Puppet TechPubs team regularly monitors and triages issues and requests here.
20-
Planning and roadmap activity takes place internally, so you may not see much activity until a writer begins actively working on a reported issue.
18+
Community members can use this repository to suggest documentation improvements.
19+
The Technical Publications team regularly monitors and triages issues and requests here.
20+
Planning and roadmap activity takes place internally, so you might not see much activity until a writer begins actively working on a reported issue.
2121

22-
💡 Note that there are no SLA agreements for issues filed in this way and customer reports take priority. If you have a support contract, you should raise issues via [support request](https://support.puppet.com/) to get them resolved expediently.
22+
💡 Restriction: There are no SLA agreements for issues filed in this way, and customer reports take priority. If you have a support contract, you should raise issues via [support request](https://support.puppet.com/) to get them resolved expediently.
2323

24-
💡 Note: As this is a public repo, please avoid including any confidential or sensitive information in issues filed.
24+
💡 Restriction: As this is a public repo, avoid including any confidential or sensitive information in issues filed.
2525

26-
1. Use the [`Issues`](https://github.com/puppetlabs/puppet-enterprise_issues/issues) tab above to get started
27-
1. Search through the existing queue to see if your concern has already been reported.
28-
* If it has been, then comment with any additional information or react with a 👍
26+
1. To get started, use the [`Issues`](https://github.com/puppetlabs/puppet-enterprise_issues/issues) tab above.
27+
2. Search the existing queue to see if your concern has already been reported:
28+
* If the concern was reported, you can comment on it with additional information or react with a 👍
2929
to add your support. You’ll get any future notifications of activity on that ticket.
30-
* If not, then file your own issue, following the issue template to include as much
31-
helpful detail as you can. Please include the full URL of the apge in question.
30+
* If the concern was not reported, you can file your own issue, following the issue template to include as much
31+
helpful detail as you can. Include the full URL of the documentation webpage.
3232

3333
Thank you so much for helping us improve our products! Email `docs@puppet.com` if you have questions about contributing to the documentation.
3434

3535

3636
## Copyright
3737

38-
Copyright (c) 2009-2021 Puppet, Inc. See LICENSE for details.
38+
Copyright (c) 2009-2024 Puppet, Inc. See LICENSE for details.

0 commit comments

Comments
 (0)