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

(MAINT) add install PE doc #41

Merged
merged 1 commit into from
Dec 27, 2016

Conversation

kevpl
Copy link
Contributor

@kevpl kevpl commented Nov 23, 2016

[skip ci]

@@ -0,0 +1,107 @@
# How-To Install Puppet Enterprise
Copy link
Contributor

Choose a reason for hiding this comment

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

maybe Puppet Enterprise installation reference? Minor quibble, just not a (hugefan) of How-To.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@tvpartytonight this isn't a reference, because it's in no way complete. 'How To' guides are a major section of our docs structure, and I've been trying to create a pattern of the path & title matching up in new docs, like in this one. Would removing the hyphen make it better in the title?

Copy link
Contributor

Choose a reason for hiding this comment

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

So, I don't think something that is called a "reference" doesn't mean it's "complete", but ultimately I don't care if you use the term reference or not. I'm just not a huge fan of the how-to redundancy. Removing the hyphen seems better to me.

them, we will now have a place to document those details, so that we can
over time bring this to 100% completeness.

# First Things First: What Do You Want to Install?
Copy link
Contributor

Choose a reason for hiding this comment

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

It's not clear to me why the documentation for install_puppet_agent_pe_promoted_repo_on is inside this document; it seems like that is a specific separate use case, tangentially related to a Puppet Enterprise installation, but ultimately not used in actually installing Puppet Enterprise itself. Am I wrong? I might be wrong...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, install_puppet_agent_pe_promoted_repo_on is a part of PE installation. A large part of this doc is to guide people to potentially using this method rather than the typical install_pe method that people use if they want to specifically just install the same agents that PE would use.

Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm, this only makes me feel stronger that we should have a specific doc on install_puppet_agent_pe_promoted_repo_on and link to that doc from here; I don't like the idea of conflating these two different things in a single document.

@kevpl kevpl force-pushed the maint_install_docs branch from 80cff2b to 4c08e56 Compare December 13, 2016 18:58
@kevpl
Copy link
Contributor Author

kevpl commented Dec 13, 2016

Moved puppet agent install docs to voxpupuli/beaker#1296. This PR is updated to depend on that.


Installing Puppet Agent from the PE promoted locations is handled in core beaker,
not in beaker-pe itself. You can read more about doing this in
[beaker's How To Install Puppet Agent Doc](https://github.com/puppetlabs/beaker/tree/master/docs/how_to/install_puppet_agent.md).
Copy link
Contributor

Choose a reason for hiding this comment

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

This link needs to be to just install_puppet, not install_puppet_agent.

@kevpl kevpl force-pushed the maint_install_docs branch from 4c08e56 to c475a8c Compare December 27, 2016 23:06
@tvpartytonight
Copy link
Contributor

👍

@tvpartytonight tvpartytonight merged commit 2e748b9 into puppetlabs:master Dec 27, 2016
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.

2 participants