Skip to content

Commit

Permalink
Merge pull request #588 from amousset/enh_23278/improve_some_messages…
Browse files Browse the repository at this point in the history
…_in_the_interface_plugins

Fixes #23278: Improve some messages in the interface - plugins
  • Loading branch information
amousset authored Aug 16, 2023
2 parents 1161a33 + bfc01a6 commit 41c9f8d
Show file tree
Hide file tree
Showing 71 changed files with 213 additions and 174 deletions.
2 changes: 1 addition & 1 deletion Jenkinsfile
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ pipeline {
agent {
dockerfile {
filename 'ci/typos.Dockerfile'
additionalBuildArgs '--build-arg VERSION=1.0'
additionalBuildArgs '--build-arg VERSION=1.16.5'
}
}
steps {
Expand Down
14 changes: 7 additions & 7 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ Once `g8` command is installed (see http://www.foundweekends.org/giter8/setup.ht
```
% g8 file://.
```
You can alos use the github resolution:
You can also use the github resolution:

```
% g8 normation/rudder-plugins
```

And answer the questions. Only the `name` is mandatory: use the plugin short name, with
space and capital if you want (see convetion below).
space and capital if you want (see convention below).
Juste hitting <ENTER> choose the default value (the one between []).

```
Expand Down Expand Up @@ -50,7 +50,7 @@ minus 'rudder-plugin-" prefix.

Each plugin build information are grouped in file `build.conf` in plugin root directory.

== Branch versionning and compatibility with Rudder versions
== Branch versioning and compatibility with Rudder versions


Plugins are linked to Rudder patch version, so we retrieve in `rudder-plugins` the same branch
Expand All @@ -64,7 +64,7 @@ corresponding Rudder patch version:
- etc
```

This scheme allows to ensure total binary compatiblity, and upgrade is done automatically by rudder package at upgrade.
This scheme allows to ensure total binary compatibility, and upgrade is done automatically by rudder package at upgrade.


== Plugin version and Tag convention
Expand All @@ -73,7 +73,7 @@ This scheme allows to ensure total binary compatiblity, and upgrade is done aut
Plugin versions are composed in two parts separated by a `-`:

- the Rudder corresponding version (including the patch number),
- the plugin own version in format X.Y(.Z) where the Z part is optionnal.
- the plugin own version in format X.Y(.Z) where the Z part is optional.

For example, the `datasources` plugin, in own version 2.1, for Rudder 7.2.3 will get version: `7.2.3-2.2`.

Expand Down Expand Up @@ -126,7 +126,7 @@ npm install -g elm
To build a plugin package, do:

```
git checkout tag-corresponding-to-plugin-vesion
git checkout tag-corresponding-to-plugin-version
make clean && make generate-all-pom && make plugin-name
```

Expand Down Expand Up @@ -172,4 +172,4 @@ https://www.rudder.io/en/expand/contribute/

== Authors

Authors are tracked by their git name and public git hostory of the project.
Authors are tracked by their git name and public git history of the project.
7 changes: 7 additions & 0 deletions _typos.toml
Original file line number Diff line number Diff line change
@@ -1,9 +1,16 @@
[default.extend-words]
monitord = "monitord"
Ser = "Ser"
unser = "unser"
# False positive on the OAUTHv2 string
OAUT = "OAUT"

# All exceptions below should be removed when upstream will be fixed
includeSytem = "includeSytem"
Sytem = "Sytem"
cssPsuedoElementExclusion = "cssPsuedoElementExclusion"
Psuedo = "Psuedo"
criterias = "criterias"
Formater = "Formater"
Provid = "Provid"
Optionnal = "Optionnal"
4 changes: 2 additions & 2 deletions ansible-policies/build.conf
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ plugin-name=ansible-policies
# the full name is derived from rudder-plugin-name
plugin-fullname=rudder-plugin-${plugin-name}

# Human readable short/title descrption (used for one line text)
# Human readable short/title description (used for one line text)
plugin-title-description="""This plugin distributes a technique to run Ansible jobs from Rudder and reports their results."""

# WEB, HTML description.
Expand All @@ -21,6 +21,6 @@ plugin-web-description=<p>This plugin distributes a technique to run Ansible job
# - A.B: Rudder major.minor
# - x.y(.z): plugin major.minor.micro. Micro should be omitted. When omitted, z is assumed to be 0.
# For the build, we split the information between two properties, rudder branch and plugin version,
# which must be concaneted with "-" to build the plugin version.
# which must be concatenated with "-" to build the plugin version.
plugin-version=2.0

2 changes: 1 addition & 1 deletion ansible-policies/packaging/postinst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ PLUGIN_FULL_NAME="rudder-plugin-ansible-policies"
PRETTY_NAME="Ansible Policies"
CONFIGURATION_PATH=/var/rudder/packages/$PLUGIN_FULL_NAME

# Code below should be mostly comon between the plugins
# Code below should be mostly common between the plugins
SOURCE_DIR=${CONFIGURATION_PATH}/techniques
CONFIG_REPO=/var/rudder/configuration-repository

Expand Down
2 changes: 1 addition & 1 deletion api-authorizations/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ You can log information about ACL (behavior and errors) by adding the following
<!--
API ACLs
========
Information about ALC evalutation for APIs.
Information about ALC evaluation for APIs.

This logger allows to get extra information about API
ACLs resolution.
Expand Down
4 changes: 2 additions & 2 deletions api-authorizations/build.conf
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ plugin-name=api-authorizations
# the full name is derived from rudder-plugin-name
plugin-fullname=rudder-plugin-${plugin-name}

# Human readable short/title descrption (used for one line text)
# Human readable short/title description (used for one line text)
plugin-title-description=Fine grained authorizations (ACL) for APIs
# WEB, HTML description.
plugin-web-description="""<p>This plugins allow to use and configure fine grained authorizations
Expand All @@ -21,5 +21,5 @@ for API tokens.</p>"""
# - A.B: Rudder major.minor
# - x.y(.z): plugin major.minor.micro. Micro should be omitted. When omitted, z is assumed to be 0.
# For the build, we split the information between two properties, rudder branch and plugin version,
# which must be concaneted with "-" to build the plugin version.
# which must be concatenated with "-" to build the plugin version.
plugin-version=2.1
2 changes: 1 addition & 1 deletion api-authorizations/src/main/elm/sources/UserApiToken.elm
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ tokenPresent token =
[ li []
[ a [ class "no-click" ]
[ span [ class "fa fa-key" ] []
, text "Your personnal token: "
, text "Your personal token: "
, div [ class "help-block" ] [ b [] [ text token.token ] ]
]
]
Expand Down
4 changes: 2 additions & 2 deletions auth-backends/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Possible values are:

* `show` [default]: show Rudder login form as usual
* `hide`: hide the login form below a toggle button. This is a good option if you want to let your user only see SSO links by default, but still have access to the login form for special cases (like, typically, for emergency admin access when the SSO or network to it is down)
* `remove`: completly remove Rudder login form.
* `remove`: completely remove Rudder login form.

For example, with an OpenID Connect service configured and the `hide` value chosen, your login form will be updated to look like:

Expand Down Expand Up @@ -253,7 +253,7 @@ rudder.auth.ldap.connection.url=ldap://ldap.mycorp.com:389/dc=mycorp,dc=com
#
# Bind DN used by Rudder to do the search. This is the "service" or
# "application" DN for Rudder in you LDAP directory, or an LDAP user with
# enought rights to be able to walk the user branch configured below.
# enough rights to be able to walk the user branch configured below.
# LDAP dn, no default value.
# Be careful to not add quote around the DN, the value is used as provided.
#
Expand Down
6 changes: 3 additions & 3 deletions auth-backends/build.conf
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ plugin-name=auth-backends
# the full name is derived from rudder-plugin-name
plugin-fullname=rudder-plugin-${plugin-name}

# Human readable short/title descrption (used for one line text)
# Human readable short/title description (used for one line text)
plugin-title-description="""Alternative Authentication Backends for Rudder"""

# WEB, HTML description.
plugin-web-description="<p>This plugin provides additionnal authentication backends for Rudder, like LDAP, OIDC, etc</p>"
plugin-web-description="<p>This plugin provides additional authentication backends for Rudder, like LDAP, OIDC, etc</p>"

# Plugin version. It is build as follow: A.B-x.y(.z) with:
# - A.B: Rudder major.minor
# - x.y(.z): plugin major.minor.micro. Micro should be omitted. When omitted, z is assumed to be 0.
# For the build, we split the information between two properties, rudder branch and plugin version,
# which must be concaneted with "-" to build the plugin version.
# which must be concatenated with "-" to build the plugin version.
plugin-version=2.6
2 changes: 1 addition & 1 deletion auth-backends/src/main/elm/sources/AuthBackends.elm
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ displayProvidConfig config =
, text "."
]
, p [] [ text """A special provider can be added for a root admin. It's an hook to
alway let the possibility to have at least one access in the application.
always let the possibility to have at least one access in the application.
That provider does not have to be declared in the list, and is always
tested first the root admin is enabled.
""" ]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ class AuthBackendsSpringConfiguration extends ApplicationContextAware {

/**
* We don't use rights provided by spring, nor the one provided by OAUTH2, so
* alway map user to role `ROLE_USER`
* always map user to role `ROLE_USER`
*/
@Bean def userAuthoritiesMapper = {

Expand Down Expand Up @@ -340,7 +340,7 @@ class AuthBackendsSpringConfiguration extends ApplicationContextAware {
new RudderOAuth2UserService(rudderUserDetailsService, registrationRepository)
}

// following beans are the detault one provided by spring security for oauth2 logic
// following beans are the default one provided by spring security for oauth2 logic

val authorizationRequestBaseUri = "/oauth2/authorization"
val loginProcessingUrl = "/login/oauth2/code/*"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ class AuthBackendsRepository(
"""Rudder has a root admin account, with full rights on the
# application, and whose authentication is independent from
# the authentication provider chosen (file, LDAP, etc).
# By default, the accound is disabled (either by letting the
# By default, the account is disabled (either by letting the
# the login or the password empty, or by commenting it).""",
login,
password,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ object AuthBackendsLoggerPure extends NamedZioLogger {

/*
* The Json ADT to present information to client side
* All the *Json case clases define an user API, any change
* All the *Json case classes define an user API, any change
* must be handle with care (and forward compatibility in mind).
*/

Expand Down
2 changes: 1 addition & 1 deletion branding/build.conf
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,5 @@ plugin-web-description="""<p>
# - A.B: Rudder major.minor
# - x.y(.z): plugin major.minor.micro. Micro should be omitted. When omitted, z is assumed to be 0.
# For the build, we split the information between two properties, rudder branch and plugin version,
# which must be concaneted with "-" to build the plugin version.
# which must be concatenated with "-" to build the plugin version.
plugin-version=2.2
8 changes: 4 additions & 4 deletions branding/src/main/elm/sources/View.elm
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ view model =

bar =
[ div [ class "panel-col col-md-6" ]
[ checkbox settings.displayBar ToggleCustomBar "enable-bar" "Display Custom Bar"
[ checkbox settings.displayBar ToggleCustomBar "enable-bar" "Display custom bar"
, div [ class "form-group" ]
[ label [] [ text "Background color" ]
, div [ class "input-group" ]
Expand Down Expand Up @@ -113,9 +113,9 @@ view model =
]
in
Html.form []
[ createPanel "Custom Logos" "custom-logos" customLogos
, createPanel "Custom Bar" "custom-bar" bar
, createPanel "Login Page" "login-page" loginPage
[ createPanel "Custom logos" "custom-logos" customLogos
, createPanel "Custom bar" "custom-bar" bar
, createPanel "Login page" "login-page" loginPage
, div [ class "toolbar" ]
[ button [ type_ "button", class "btn btn-success", onClick SendSave ] [ text "Save" ]
]
Expand Down
6 changes: 3 additions & 3 deletions centreon/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Note: Rule is the application of one or more directives to a group of nodes.
It is the glue between both Asset Management and Configuration Management parts of
the application.

* Centreon comes with the possiblity to add monitoring templates to its hosts.
* Centreon comes with the possibility to add monitoring templates to its hosts.

* Create a service template model in centreon or check for available ones proposed by Centreon interface.

Expand All @@ -96,10 +96,10 @@ generic method from the technique editor.

In order to configure the monitoring of the Rudder nodes, you can provide Centreon with parameters associated to its hosts. The *Monitoring parameter* generic method achieves this.

At this stage, Centreon supervise your rudder-node services in a fairly syncronized way.
At this stage, Centreon supervise your rudder-node services in a fairly synchronized way.

The data will be sent to the Centreon server after the agent and the
synchonization process have run. This synchonization process can be
synchronization process have run. This synchronization process can be
manually executed by running:

----
Expand Down
4 changes: 2 additions & 2 deletions centreon/build.conf
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ plugin-name=centreon
# the full name is derived from rudder-plugin-name
plugin-fullname=rudder-plugin-${plugin-name}

# Human readable short/title descrption (used for one line text)
# Human readable short/title description (used for one line text)
plugin-title-description="""Plugin for Centreon integration with Rudder"""

# WEB, HTML description.
Expand All @@ -21,5 +21,5 @@ plugin-web-description=<p>Plugin for Centreon integartion with Rudder</p>
# - A.B: Rudder major.minor
# - x.y(.z): plugin major.minor.micro. Micro should be omitted. When omitted, z is assumed to be 0.
# For the build, we split the information between two properties, rudder branch and plugin version,
# which must be concaneted with "-" to build the plugin version.
# which must be concatenated with "-" to build the plugin version.
plugin-version=2.1
4 changes: 2 additions & 2 deletions change-validation/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Change request information::

display common information (title, description, status, id) and a form to edit them.

image::docs/images/Informations.png[]
image::docs/images/Information.png[]

Change request content::

Expand Down Expand Up @@ -245,4 +245,4 @@ image::docs/images/1_Validated_User.png[List of validated users]

image::docs/images/2_Validated_User.png[Update validated users]

image::docs/images/3_Validated_User.png[Upadated list of validated users]
image::docs/images/3_Validated_User.png[Updated list of validated users]
4 changes: 2 additions & 2 deletions change-validation/build.conf
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ plugin-name=change-validation
# the full name is derived from rudder-plugin-name
plugin-fullname=rudder-plugin-${plugin-name}

# Human readable short/title descrption (used for one line text)
# Human readable short/title description (used for one line text)
plugin-title-description="""Enable configuration change requests and validation workflows in Rudder"""

# WEB, HTML description.
Expand All @@ -21,5 +21,5 @@ plugin-web-description=<p>Enable configuration change requests and validation wo
# - A.B: Rudder major.minor
# - x.y(.z): plugin major.minor.micro. Micro should be omitted. When omitted, z is assumed to be 0.
# For the build, we split the information between two properties, rudder branch and plugin version,
# which must be concaneted with "-" to build the plugin version.
# which must be concatenated with "-" to build the plugin version.
plugin-version=2.2
2 changes: 1 addition & 1 deletion change-validation/src/main/elm/sources/Init.elm
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ getErrorMessage e =
Http.NetworkError ->
"Network error"
Http.BadBody c->
"Wront content in request body" ++ c
"Wrong content in request body" ++ c
in
errMessage

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -401,7 +401,7 @@ getErrorMessage e =
Http.NetworkError ->
"Network error"
Http.BadBody c->
"Wront content in request body" ++ c
"Wrong content in request body" ++ c

in
errMessage
Expand Down
6 changes: 3 additions & 3 deletions change-validation/src/main/elm/sources/View.elm
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ renderUserHelper user pos model =
if not user.isInFile then
createInfoTootlip
"""
This user <b> doesn't exist anymore </b> but he is still a validated user, delete him by removing him from the validated users.
The user <b> doesn't exist anymore </b> but they are still a validated user, delete them by removing them from the validated users.
"""
"auto"
else
Expand Down Expand Up @@ -255,7 +255,7 @@ displayLeftCol model =
[
div [ class "box-users-container "]
[
h5 [class "box-header"] [ b [][text "Validated Users"]],
h5 [class "box-header"] [ b [][text "Validated users"]],
div [class "box-users-content"]
[
if isEmpty model.validatedUsers then
Expand All @@ -265,7 +265,7 @@ displayLeftCol model =
i [class "fa fa-user-times empty-validated-user", style "margin-bottom" "10px"]
[
br [][],
p [class "empty-box-msg"] [text "No Validated Users found"]
p [class "empty-box-msg"] [text "No validated users found"]
]
else
div [] []
Expand Down
Loading

0 comments on commit 41c9f8d

Please sign in to comment.