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

fix: remove dash in 'multi-...' terms according to IBM Style Guide #2095

Merged
merged 14 commits into from
Aug 23, 2021
Merged

fix: remove dash in 'multi-...' terms according to IBM Style Guide #2095

merged 14 commits into from
Aug 23, 2021

Conversation

max-cx
Copy link
Contributor

@max-cx max-cx commented Aug 11, 2021 •
edited
Loading

Read our Contribution guide before submitting a PR.

What does this PR do?

In line with the IBM Style Guide, removed dash in 'multi-...' terms where applicable following a Google search of established usage.

What issues does this PR fix or reference?

1711

Specify the version of the product this PR applies to.

Che 7.32, Che 7.34

PR Checklist

As the author of this Pull Request I made sure that:

  • vale has been run successfully against the PR branch
  • Link checker has been run successfully against the PR branch
  • Documentation describes a scenario that is already covered by QE tests, otherwise an issue has been created and acknowledged by Che QE team
  • Changed article references are updated where they are used (or a redirect has been configured on the docs side):

@max-cx
[1711] fix: Replaced 'multi-user-specific' with 'multiuser'
2177d98 
Heading: Multi-user-specific OpenShift infrastructure configuration
Table: Multi-user-spePcific OpenShift infrastructure configuration

Bug: https://issues.redhat.com/browse/RHDEVDOCS-1711
@max-cx
[1711] fix: rewrite 'multi-user mode' as 'multiuser mode'
478d708 
 Changes to be committed:
	modified:   modules/administration-guide/partials/con_che-keycloak.adoc
	modified:   modules/administration-guide/partials/con_che-postgresql.adoc
	modified:   modules/administration-guide/partials/con_che-server.adoc
	modified:   modules/administration-guide/partials/con_che-workspace-jwt-proxy.adoc
	modified:   modules/administration-guide/partials/proc_configuring-github-oauth.adoc

Bug: https://issues.redhat.com/browse/RHDEVDOCS-1711
@max-cx
[1711] fix: rewrite 'multi-user' as 'multiuser' and 'multi-tenant' as…
46c2ed9 
… 'multitenant'

 Changes to be committed:
	modified:   modules/administration-guide/partials/con_che-workspace-controller.adoc
	modified:   modules/installation-guide/examples/system-variables.adoc
	modified:   modules/installation-guide/partials/assembly_installing-che.adoc
	modified:   modules/overview/partials/assembly_introduction-to-eclipse-che.adoc

Bug: https://issues.redhat.com/browse/RHDEVDOCS-1711
@max-cx
[1711] fix: rewrite 'multi-line' as 'multiline' in the tool scripts
603fe43 
 Changes to be committed:
	modified:   tools/environment_docs_gen.sh
	modified:   tools/test-adoc.sh

Bug: https://issues.redhat.com/browse/RHDEVDOCS-1711
@max-cx
[1711] rewrote 'multi-cluster' as 'multicluster'
6052e73 
 Changes to be committed:
	modified:   modules/installation-guide/partials/proc_switching-between-external-and-internal-communication.adoc

Bug: https://issues.redhat.com/browse/RHDEVDOCS-1711
@max-cx
[1711] fix: rewrite 'multi-cluster' as 'multicluster' and 'multi-zone…
9610fc4 
…' as 'multizone'

 Changes to be committed:
	modified:   modules/installation-guide/partials/proc_configuring-workspaces-nodeselector.adoc
	modified:   modules/installation-guide/partials/proc_switching-between-external-and-internal-communication.adoc

Bug: https://issues.redhat.com/browse/RHDEVDOCS-1711
@max-cx
[1711] fix: rewrite 'multi-host mode' as 'multihost mode'
bf799bf 
 Changes to be committed:
	modified:   modules/end-user-guide/pages/differences-in-how-che-theia-webview-works-on-a-single-host-mode-comparing-to-a-multi-host-mode.adoc
	modified:   modules/end-user-guide/partials/assembly_differences-in-how-che-theia-webview-works-on-a-single-host-mode-comparing-to-a-multi-host-mode.adoc

Bug: https://issues.redhat.com/browse/RHDEVDOCS-1711
@max-cx
[1711] fix: rewriting 'multi-host strategy' as 'multihost strategy'
8750f3a 
'multi-host (server exposure) strategy' > 'multihost (server exposure) strategy'

retained exceptions: `multi-host` (e.g., devfile fields)

 Changes to be committed:
	modified:   modules/installation-guide/partials/con_workspace-exposure-strategies.adoc
	modified:   modules/installation-guide/partials/proc_configuring-namespace-strategies.adoc

Bug: https://issues.redhat.com/browse/RHDEVDOCS-1711
@max-cx max-cx requested a review from ibuziuk August 11, 2021 16:35
@MichalMaler MichalMaler added kind/enhancement need-cherry-pick/7.34.x need cherry-pick to 7.18.x branch need-cherry-pick/7.32.x need cherry-pick to 7.32.x labels Aug 12, 2021
@themr0c
Copy link
Contributor

themr0c commented Aug 17, 2021

As it is conflictual with the behavior of the spellchecker that Vale is using, we need to add the new words in the dictionary, in .vale/styles/Vocab/Che/accept.txt.

@themr0c themr0c added this to the 7.34.x milestone Aug 17, 2021
@themr0c themr0c added this to In progress in Reviews via automation Aug 17, 2021
@themr0c themr0c self-assigned this Aug 17, 2021
max-cx and others added 5 commits August 19, 2021 15:52
@max-cx
Merge branch 'master' into 1711
4508442
@max-cx
Merge branch 'master' into 1711
0377d1c
@themr0c
Merge branch 'master' into 1711
19e6e24
@max-cx
[1711] Editing Vale accept.txt and reject.txt
8c56491 
 Changes to be committed:

	modified:   .vale/styles/Vocab/Che/accept.txt
	+ [Mm]ulticluster
	+ [Mm]ultihost
	+ [Mm]ultitenant
	+ [Mm]ultizone

	modified:   .vale/styles/Vocab/Che/reject.txt
	+ [Mm]ulti-cluster
	+ [Mm]ulti-host
	+ [Mm]ulti-tenant
	+ [Mm]ulti-zone

Bug: https://issues.redhat.com/browse/RHDEVDOCS-1711
@max-cx
[1711] Editing Vale accept.txt and reject.txt
7818ca8 
 Changes to be committed:

	modified:   .vale/styles/Vocab/Che/accept.txt
	+ [Mm]ulticluster
	+ [Mm]ultihost
	+ [Mm]ultinode
	+ [Mm]ultitenant
	+ [Mm]ultizone

	modified:   .vale/styles/Vocab/Che/reject.txt
	+ [Mm]ulti-cluster
	+ [Mm]ulti-host
	+ [Mm]ulti-node
	+ [Mm]ulti-tenant
	+ [Mm]ulti-zone

Bug: https://issues.redhat.com/browse/RHDEVDOCS-1711
Reviews automation moved this from In progress to Reviewer approved Aug 23, 2021
@themr0c themr0c merged commit d663eb2 into eclipse-che:master Aug 23, 2021
Reviews automation moved this from Reviewer approved to Done Aug 23, 2021
themr0c added a commit that referenced this pull request Sep 7, 2021
@max-cx @themr0c
fix: remove dash in 'multi-...' terms according to IBM Style Guide (#…
7f50e75 
…2095)

* [1711] fix: Replaced 'multi-user-specific' with 'multiuser'

Heading: Multi-user-specific OpenShift infrastructure configuration
Table: Multi-user-spePcific OpenShift infrastructure configuration

Bug: https://issues.redhat.com/browse/RHDEVDOCS-1711

* [1711] fix: rewrite 'multi-user mode' as 'multiuser mode'

 Changes to be committed:
	modified:   modules/administration-guide/partials/con_che-keycloak.adoc
	modified:   modules/administration-guide/partials/con_che-postgresql.adoc
	modified:   modules/administration-guide/partials/con_che-server.adoc
	modified:   modules/administration-guide/partials/con_che-workspace-jwt-proxy.adoc
	modified:   modules/administration-guide/partials/proc_configuring-github-oauth.adoc

Bug: https://issues.redhat.com/browse/RHDEVDOCS-1711

* [1711] fix: rewrite 'multi-user' as 'multiuser' and 'multi-tenant' as 'multitenant'

 Changes to be committed:
	modified:   modules/administration-guide/partials/con_che-workspace-controller.adoc
	modified:   modules/installation-guide/examples/system-variables.adoc
	modified:   modules/installation-guide/partials/assembly_installing-che.adoc
	modified:   modules/overview/partials/assembly_introduction-to-eclipse-che.adoc

Bug: https://issues.redhat.com/browse/RHDEVDOCS-1711

* [1711] fix: rewrite 'multi-line' as 'multiline' in the tool scripts

 Changes to be committed:
	modified:   tools/environment_docs_gen.sh
	modified:   tools/test-adoc.sh

Bug: https://issues.redhat.com/browse/RHDEVDOCS-1711

* [1711] rewrote 'multi-cluster' as 'multicluster'

 Changes to be committed:
	modified:   modules/installation-guide/partials/proc_switching-between-external-and-internal-communication.adoc

Bug: https://issues.redhat.com/browse/RHDEVDOCS-1711

* [1711] fix: rewrite 'multi-cluster' as 'multicluster' and 'multi-zone' as 'multizone'

 Changes to be committed:
	modified:   modules/installation-guide/partials/proc_configuring-workspaces-nodeselector.adoc
	modified:   modules/installation-guide/partials/proc_switching-between-external-and-internal-communication.adoc

Bug: https://issues.redhat.com/browse/RHDEVDOCS-1711

* [1711] fix: rewrite 'multi-host mode' as 'multihost mode'

 Changes to be committed:
	modified:   modules/end-user-guide/pages/differences-in-how-che-theia-webview-works-on-a-single-host-mode-comparing-to-a-multi-host-mode.adoc
	modified:   modules/end-user-guide/partials/assembly_differences-in-how-che-theia-webview-works-on-a-single-host-mode-comparing-to-a-multi-host-mode.adoc

Bug: https://issues.redhat.com/browse/RHDEVDOCS-1711

* [1711] fix: rewriting 'multi-host strategy' as 'multihost strategy'

'multi-host (server exposure) strategy' > 'multihost (server exposure) strategy'

retained exceptions: `multi-host` (e.g., devfile fields)

 Changes to be committed:
	modified:   modules/installation-guide/partials/con_workspace-exposure-strategies.adoc
	modified:   modules/installation-guide/partials/proc_configuring-namespace-strategies.adoc

Bug: https://issues.redhat.com/browse/RHDEVDOCS-1711

* [1711] Editing Vale accept.txt and reject.txt

 Changes to be committed:

	modified:   .vale/styles/Vocab/Che/accept.txt
	+ [Mm]ulticluster
	+ [Mm]ultihost
	+ [Mm]ultitenant
	+ [Mm]ultizone

	modified:   .vale/styles/Vocab/Che/reject.txt
	+ [Mm]ulti-cluster
	+ [Mm]ulti-host
	+ [Mm]ulti-tenant
	+ [Mm]ulti-zone

Bug: https://issues.redhat.com/browse/RHDEVDOCS-1711

* [1711] Editing Vale accept.txt and reject.txt

 Changes to be committed:

	modified:   .vale/styles/Vocab/Che/accept.txt
	+ [Mm]ulticluster
	+ [Mm]ultihost
	+ [Mm]ultinode
	+ [Mm]ultitenant
	+ [Mm]ultizone

	modified:   .vale/styles/Vocab/Che/reject.txt
	+ [Mm]ulti-cluster
	+ [Mm]ulti-host
	+ [Mm]ulti-node
	+ [Mm]ulti-tenant
	+ [Mm]ulti-zone

Bug: https://issues.redhat.com/browse/RHDEVDOCS-1711

Co-authored-by: Fabrice Flore-Thébault <ffloreth@redhat.com>
@themr0c themr0c added cherry-picked to 7.34.x for CRW 2.6 and removed need-cherry-pick/7.34.x need cherry-pick to 7.18.x branch labels Sep 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tolusha tolusha tolusha approved these changes

@rkratky rkratky rkratky approved these changes

@MichalMaler MichalMaler Awaiting requested review from MichalMaler

@themr0c themr0c Awaiting requested review from themr0c

@ibuziuk ibuziuk Awaiting requested review from ibuziuk

Assignees

@themr0c themr0c

Labels
cherry-picked to 7.34.x for CRW 2.6 kind/bug kind/enhancement need-cherry-pick/7.32.x need cherry-pick to 7.32.x
Projects
Reviews
  
Done
Milestone
7.34.x
6 participants
@max-cx @themr0c @tolusha @rkratky @che-bot @MichalMaler