Skip to content

Commit be60a63

Browse files
authored
Merge pull request circleci#3795 from circleci/KyleTryon-patch-1
minor grammatical changes.
2 parents ede2649 + 01238d7 commit be60a63

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

jekyll/_cci2/orb-author-faq.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Read more in our [Orbs Quickstart]({{site.baseurl}}/2.0/orb-author/#orbs-quickst
3535

3636
* Question: How do I protect a user's API tokens and other sensitive information?
3737

38-
* Answer: Utilize the "env_var_name" parameter type for the API key parameter. This parameter type will only accept POSIX valid environment variable name strings as valid. In the parameter description it is best to mention to the user to add this environment variable.
38+
* Answer: Utilize the `env_var_name` parameter type for the API key parameter. This parameter type will only accept valid POSIX environment variable name strings as valid input. In the parameter description it is best to mention to the user to add this environment variable.
3939

4040
Read more:
4141
* [Environment Variable Name]({{site.baseurl}}/2.0/reusing-config/#environment-variable-name)
@@ -44,7 +44,7 @@ Read more:
4444
## Environment Variables
4545

4646
* Question: How can I require a user to add an environment variable?
47-
* Answer: Create a parameter for the environment variable name, even if it is a statically named environment variable the user _should not_ change, and assign it the correct default value. In the parameter description let the user know if this value should not be changed. In either event instruct the user where they can obtain their API key.
47+
* Answer: Create a parameter for the environment variable name, even if it is a statically named environment variable the user _should not_ change. Then, assign it the correct default value. In the parameter description let the user know if this value should not be changed. In either event instruct the user where they can obtain their API key.
4848

4949
Consider validating required environment variables. [See more]({{site.baseurl}}/2.0/orbs-best-practices/#commands).
5050

@@ -64,7 +64,7 @@ CircleCI orbs package [CircleCI reusable config]({{site.baseurl}}/2.0/reusing-co
6464

6565
**Bash**
6666

67-
Bash is the preferred language as it is most commonly available among all available executors. Bash can be (and should) easily written directly using the native [run]({{site.baseurl}}/2.0/configuration-reference/#run) command. The default shell MacOS and Linux will be Bash.
67+
Bash is the preferred language as it is most commonly available among all available executors. Bash can be (and should) easily written directly using the native [run]({{site.baseurl}}/2.0/configuration-reference/#run) command. The default shell on MacOS and Linux will be Bash.
6868

6969
**Interactive Interpreter (Ex: Python)**
7070

0 commit comments

Comments
 (0)