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

Align terminology with Puppet; bare => plain #1228

Merged
merged 2 commits into from
Oct 25, 2021

Conversation

reidmv
Copy link
Contributor

@reidmv reidmv commented Sep 24, 2021

Puppet already uses a term in the indirector system to indicate that an implementation doesn't really do anything, and that term is "plain". For the R10K environment type that doesn't do anything, we should use this same terminology. The initial choice of the term "bare" isn't ecosystem congruent, and has the language problem of being used meaningfully when describing Git repos, but that meaning doesn't translate at all to the environment type.

Using the term "plain" both aligns terminology with Puppet, and eliminates any potential language collisions with the Git meaning of the term.

I doubt this feature is much-used, and it's still documented as "experimental" so we could probably just change the name and be done. The PR includes a formal deprecation just in case anyone thinks it's needed pre-4.0.

Please add all notable changes to the "Unreleased" section of the CHANGELOG in the format:

- (JIRA ticket) Summary of changes. [Issue or PR #](link to issue or PR)

Copy link
Contributor

@mwaggett mwaggett left a comment

Choose a reason for hiding this comment

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

This generally looks good! Just a couple small nits, and this needs a rebase.

We're planning to do an r10k release today, so if you could make those tweaks ASAP, that would be great! Otherwise, if you don't mind (and perms allow), I can force-push to your branch to get this fixed up.

doc/dynamic-environments/configuration.mkd Show resolved Hide resolved
Comment on lines 5 to 6
let(:basepath) { '/some/imaginary/path' }
let(:envname) { 'env_name' }
Copy link
Contributor

Choose a reason for hiding this comment

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

Doesn't look like these lets are needed, if you're just using string params below.

@mwaggett
Copy link
Contributor

also @reidmv if you wouldn't mind opening an RK ticket for removing the bare type altogether in 4.0.0, that would be much appreciated!

Puppet already uses a term in the indirector system to indicate that an
implementation doesn't really do anything, and that term is "plain". For
the R10K environment type that doesn't do anything, we should use this
same terminology. The initial choice of the term "bare" isn't ecosystem
congruent, and has the language problem of being used meaningfully when
describing Git repos, but that meaning doesn't translate at all to the
environment type.

Using the term "plain" both aligns terminology with Puppet, and
eliminates any potential language collisions with the Git meaning of the
term.
@reidmv
Copy link
Contributor Author

reidmv commented Oct 25, 2021

@mwaggett rebased, addressed nits, filed #1235

@mwaggett mwaggett merged commit 9f93336 into puppetlabs:main Oct 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants