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.

Sign up for GitHub

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

Jump to bottom

Fixes #10214: More consistant naming of techniques #1118

Merged
merged 1 commit into from
Feb 17, 2017
Merged

Fixes #10214: More consistant naming of techniques #1118

merged 1 commit into from
Feb 17, 2017

Conversation

amousset
Copy link
Member

@amousset
Copy link
Member Author

Do not merge for now, still unsure about consequences of renaming categories.

jooooooon
jooooooon reviewed Feb 16, 2017
View reviewed changes
Copy link
Member

@jooooooon jooooooon left a comment

Choose a reason for hiding this comment

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

This is a GREAT change! It's going to make things so much clearer!

techniques/applications/aptPackageManagerSettings/3.1/metadata.xml Outdated
-->
<TECHNIQUE name="APT package manager configuration">
<DESCRIPTION>This technique configure the APT package manager.</DESCRIPTION>
<TECHNIQUE name="Package sources (APT)">
Copy link
Member

Choose a reason for hiding this comment

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

This is actually 2 things in one: package sources (aka repos) and package manager settings. How about "Package sources and settings (APT)" ?

techniques/applications/repoGpgKeyManagement/1.0/metadata.xml Outdated
@@ -20,7 +20,7 @@

-->

<TECHNIQUE name="Repository GPG Key Management for RPM / APT Systems">
<TECHNIQUE name="Package repository keys">
Copy link
Member

Choose a reason for hiding this comment

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

I think this should be "Package repository keys (RPM/APT)"

techniques/applications/zypperPackageManagerSetup/1.0/metadata.xml Outdated
@@ -13,8 +13,8 @@ GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
-->
<TECHNIQUE name="Zypper package manager setup">
<DESCRIPTION>This technique setups Zypper package manager.</DESCRIPTION>
<TECHNIQUE name="Package manager configuration (Zypper)">
Copy link
Member

Choose a reason for hiding this comment

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

s/configuration/settings/ ?

techniques/applications/zmdPackageManagerSettings/3.0/metadata.xml Outdated
@@ -13,7 +13,7 @@ GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
-->
<TECHNIQUE name="RUG / YaST package manager configuration (ZMD)">
<TECHNIQUE name="Package manager configuration (RUG/YaST/ZMD)">
Copy link
Member

Choose a reason for hiding this comment

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

s/configuration/settings/ ?

techniques/fileDistribution/copyGitFile/2.1/metadata.xml Outdated
@@ -14,7 +14,7 @@ You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
-->

<TECHNIQUE name="Download a file from the shared folder">
<TECHNIQUE name="File download (from the policy server)">
Copy link
Member

Choose a reason for hiding this comment

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

I think this should be "File download (from Rudder server)". No "the", and more specific.

Copy link
Member

Choose a reason for hiding this comment

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

Or maybe even, judging by it's little brother "File download (HTTP)", maybe just "File download (Rudder)" ?

Copy link
Member Author

Choose a reason for hiding this comment

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

"File download (Rudder server)" ?

Copy link
Member

Choose a reason for hiding this comment

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

Works for me.

techniques/fileDistribution/manageKeyValueFile/1.0/metadata.xml Outdated
@@ -14,8 +14,7 @@ You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
-->

<!-- This technique lets user define a key-value in a file -->
<TECHNIQUE name="Manage keys-values in file">
<TECHNIQUE name="File content from key-value pairs">
Copy link
Member

Choose a reason for hiding this comment

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

I think this title is a bit misleading. It sounds like you can pass in a dict of key-value pairs to make up a file. But actually it's a special technique to manage files that are in key-value format.

How about "File content (key/value format)"?

techniques/systemSettings/process/category.xml Outdated
@@ -16,5 +16,5 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.

<xml>
<name>Process</name>
Copy link
Member

Choose a reason for hiding this comment

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

This should be renamed "Services" if possible, since the only visible technique in it is also about Services.

Copy link
Member Author

Choose a reason for hiding this comment

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

I talked with @fanf about renaming categories, and it seems it is not properly doable for now.

techniques/systemSettings/remoteAccess/sshKeyDistribution/3.0/metadata.xml Outdated
It is intended to check if all the required SSH keys are installed.
-->
<TECHNIQUE name="SSH keys distribution">
<TECHNIQUE name="SSH keys">
Copy link
Member

Choose a reason for hiding this comment

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

I think this would be clearer if it's "SSH authorised keys" or "SSH user authorised keys" or "SSH authorised keys (users)"

techniques/systemSettings/security/fileAlterationMonitoring/2.0/metadata.xml Outdated
@@ -14,7 +14,7 @@ You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
-->

<TECHNIQUE name="Monitor a file or directory content">
<TECHNIQUE name="File and directory monitoring">
Copy link
Member

Choose a reason for hiding this comment

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

This is close but not very evocative for those who know and deal with these concepts. How about "File integrity"?

Copy link
Member Author

Choose a reason for hiding this comment

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

much better

techniques/systemSettings/systemManagement/fstabConfiguration/4.0/metadata.xml Outdated
given parameters.
-->
<TECHNIQUE name="Fstab configuration">
<TECHNIQUE name="Mountpoints (fstab)">
Copy link
Member

Choose a reason for hiding this comment

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

That's two words: "Mount points". But shouldn't this be "Filesystem mount points"? Since we act on filesystems, and mount points are the settings?

@amousset
Copy link
Member Author

Commit modified

@amousset amousset force-pushed the ust_10214/more_consistant_naming_of_techniques branch from 8ac42f3 to 7cb6fe5 Compare February 17, 2017 09:22
@Normation-Quality-Assistant
Copy link
Contributor

OK, merging this PR

@Normation-Quality-Assistant Normation-Quality-Assistant merged commit 7cb6fe5 into Normation:branches/rudder/4.1 Feb 17, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jooooooon jooooooon jooooooon left review comments

Assignees
No one assigned
Labels
Ready for merge
Projects
None yet
Milestone
No milestone
3 participants
@amousset @Normation-Quality-Assistant @jooooooon