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

Make the capitalization of Execution Environment coherent #577

Closed
wants to merge 1 commit into from

Conversation

Fale
Copy link

@Fale Fale commented Jul 12, 2023

My assumption is that the correct one would be "Execution Environment", since it is abbreviated "EE", but if the correct one is different, please let me know and I will change the PR to match the preferred capitalization.

@Fale Fale requested a review from a team as a code owner July 12, 2023 10:39
@github-actions github-actions bot added docs Changes to documentation needs_triage New item that needs to be triaged labels Jul 12, 2023
@Shrews
Copy link
Contributor

Shrews commented Jul 12, 2023

ping @acozine ... since you helped rewrite a lot of these docs, do you have any thoughts on this?

@Akasurde
Copy link
Member

cc @samccann Could you please review this? Thanks in advance.

@samccann
Copy link
Contributor

Hi @Fale and thanks for opening the docs PR! So I would normally agree with you 100%. Unfortunately, we are a bit stuck. Execution environments from a Red Hat perspective, don't have capitalization. Now the difficult part? We as community have already gotten used to calling them EEs as an abbreviation for execution environments. I don't think we want to start calling them ees so we'll have to live with the discrepency at this point.

So I don't think we want to make the changes in this PR.

@Fale
Copy link
Author

Fale commented Jul 19, 2023

@samccann this is messy :-/

I think we should try to think the issue in 2 ways:

  1. Should the community (ie: this website and many others) be implementing Red Hat's standard? (personally I think it would make sense)
  2. If so, can we document those standards (also for Plyabooks vs playbooks, Inventory vs inventory, etc)? Creating a page about it would really help to start working in a standardized direction.

Interestingly enough, it seems like the "execution environment" capitalization memo was not received everywhere in Red Hat as well, since there are a lot of inconsistencies there as well.

@samccann
Copy link
Contributor

@felixfontein valid points. My personal feeling is don't capitalize anything that isn't a specific product or project name. (even tho that may differ from Red Hat's guidelines). But i could go either way.

I'll verify internally with RH writers about EEs and also see if they have a list we could..ahem..borrow for these decisions.

@samccann
Copy link
Contributor

Thanks @Fale for your patience here as we dig into the details.

So official RH style is lowercase execution environment.

Since we have attention here - should we stop calling them EEs and just spell out execution environment everywhere? @felixfontein @Andersson007 ?

@felixfontein
Copy link
Contributor

I think using the abbreviation EE for execution environment is still useful. You don't always want to spell out the full name.

@Andersson007
Copy link
Contributor

Since we have attention here - should we stop calling them EEs and just spell out execution environment everywhere?

My opinion would be to use at least at the beginning of each docs execution environment (EE) or execution environment (hereinafter EE) and then allow to use the abbreviation. It's OK using things like FQCN, etc. as it looks good to me and saves time:) Moreover, people often use the abbreviations in their speech.

I'm not against using execution environment instead but in this case we should use this approach everywhere (with things like FQCN too...)

@samccann
Copy link
Contributor

no need for ``hereinafter` but otherwise agree, thanks

I opened a separate issue so we can formalize some of our terminology - ansible/ansible-documentation#152

Thanks @Fale for getting the ball rolling on formalizing these terms. I'm closing this one since we have consensus to keep it lowercase (and keep EE) for now.

@samccann
Copy link
Contributor

AAHAHAHA omgosh I have delusions of grandeur! Since this isn't the main ansible docs, i don't get to close etc. So up to the builder folks to decide if they agree with us at this point.

@Shrews
Copy link
Contributor

Shrews commented Jul 20, 2023

@samccann As you wish.... :)

@Shrews Shrews closed this Jul 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Changes to documentation needs_triage New item that needs to be triaged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants