Skip to content

Commit 4f18b95

Browse files
EdifyContentZachGoldbergyhakbar
authored
Getting started-edify : Changes only to Overview / Getting-Started files (#2310)
* Update index.md For getting-started-edify folder * Update create-account.md For getting started folder * Update invite-team.md * Update link-github-id.md * Update docs/2.0/docs/overview/getting-started/index.md * Update docs/2.0/docs/overview/getting-started/invite-team.md * Update docs/2.0/docs/overview/getting-started/invite-team.md * Update docs/2.0/docs/overview/getting-started/link-github-id.md Co-authored-by: Yousif Akbar <[email protected]> * fix KodeKloud --------- Co-authored-by: Zach Goldberg <[email protected]> Co-authored-by: Yousif Akbar <[email protected]> Co-authored-by: Zach Goldberg <[email protected]>
1 parent 05a1806 commit 4f18b95

File tree

5 files changed

+57
-50
lines changed

5 files changed

+57
-50
lines changed

custom-dictionary.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,5 @@ dlist
4646
DEPENDENCYID
4747
MTTR
4848
terrapatch
49-
Terrapatch
49+
Terrapatch
50+
KodeKloud

docs/2.0/docs/overview/getting-started/create-account.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,35 +2,36 @@
22

33
## 1. Accept your invitation
44

5-
You’ll receive an invitation email from `[email protected]` prompting you to sign in and set up your account. Click on the button in the invitation email.
5+
You’ll receive an email invitation from `[email protected]` prompting you to sign in and set up your account. Click the button in the invitation email.
66

7-
After reviewing the privacy policy and website terms, check the box to indicate your agreement. You can then proceed to accept your invitation using only the email address to which the invite was sent. If it's a Google email, click **Continue With Google**; otherwise, enter your name and click **Continue with Email**.
7+
After reviewing the privacy policy and website terms, check the box to indicate your agreement. Proceed to accept your invitation using the email address to which the invitation was sent. If it's a Google email, click **Continue With Google**; otherwise, enter your name and click **Continue with Email**.
88

99
:::note
1010

11-
The *first* invitation email sent following the purchase of a new subscription may be forwarded to the appropriate admin for the team.
11+
The *first* invitation email sent after purchasing a new subscription may be forwarded to the appropriate team admin.
1212

1313
:::
1414

1515
## 2. Confirm your email address
1616

17-
If you continue with email, you’ll be prompted to check your inbox. Gruntwork uses a passwordless email authentication flow each time you sign in. Just click the link in that email to finish signing in.
17+
If you choose to continue with email, you’ll be prompted to check your inbox. Gruntwork uses a passwordless email authentication flow for every login. Click the link in the email to complete the sign-in process.
1818

19-
If you receive an error indicating that the link has expired immediately after attempting to sign in, it's likely due to software such as Microsoft SafeLink™ or Mimecast, which pre-processes links for security, thus invalidating it for using to sign in. Request a new sign-in link, then refer to the **Trouble Signing In** section at the bottom of the email. Select the displayed link text, then copy and paste it into your browser to sign in.
19+
If you encounter an error stating that the link has expired, it may be due to security software such as Microsoft SafeLink™ or Mimecast, which pre-processes links and invalidates them. Request a new sign-in link, then refer to the **Trouble Signing In** section at the bottom of the email. Copy and paste the displayed link text directly into your browser to sign in.
2020

2121
:::note
2222

23-
For security, sign in emails expire after 10 minutes. You can enter your email at [app.gruntwork.io](https://app.gruntwork.io) to receive a new sign in link at any time.
23+
For security, sign-in links expire after 10 minutes. You can request a new sign-in link anytime by entering your email at [app.gruntwork.io](https://app.gruntwork.io).
2424

2525
:::
2626

2727

2828
## 3. Provide account details
2929

30-
If you are the admin for your organization, you'll be prompted to confirm details including your company address and phone number, as well as a billing email. Provide the required information and click **Continue** to finish signing in.
30+
If you are the admin for your organization, youll be prompted to confirm details such as your company address, phone number, and billing email. Provide the required information and click **Continue** to complete the sign-in process.
3131

32-
## Related Knowledge Base Discussions
32+
## Related knowledge base discussions
3333

3434
- [Invitation to the Developer Portal not received](https://github.com/orgs/gruntwork-io/discussions/716)
3535
- [Trouble logging into the Portal with email](https://github.com/orgs/gruntwork-io/discussions/395)
3636
- [How can the email associated with an account be changed?](https://github.com/orgs/gruntwork-io/discussions/714)
37+
Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,40 @@
11
# Setting up DevOps Foundations & Components
22
import PersistentCheckbox from '/src/components/PersistentCheckbox';
33

4-
### Step 1: [Activate Your Gruntwork Account](/2.0/docs/overview/getting-started/create-account)
4+
### Step 1: [Activate your Gruntwork account](/2.0/docs/overview/getting-started/create-account)
55

6-
Set up your Gruntwork account and invite your teammates to gain access to Gruntwork resources.
6+
Create your Gruntwork account and invite your team members to access Gruntwork resources.
77

88
<PersistentCheckbox id="install-df-1" label="Gruntwork Account Ready" />
99

10-
### Step 2: [Set Up a Landing Zone](/2.0/docs/pipelines/installation/prerequisites/awslandingzone)
10+
### Step 2: [Set up a Landing Zone](/2.0/docs/pipelines/installation/prerequisites/awslandingzone)
1111

12-
Gruntwork's AWS Landing Zone walkthrough provides a best practice multi-account setup ready to use with DevOps Foundations.
12+
Follow Gruntwork's AWS Landing Zone walkthrough to implement a best-practice multi-account setup, ready for use with DevOps Foundations.
1313

1414
<PersistentCheckbox id="install-df-2" label="AWS Landing Zone Ready" />
1515

16-
### Step 3: [Configure Pipelines Authentication](/2.0/docs/pipelines/installation/authoverview)
16+
### Step 3: [Configure Pipelines authentication](/2.0/docs/pipelines/installation/authoverview)
17+
18+
Set up authentication for Pipelines to enable secure automation of infrastructure changes.
1719

1820
<PersistentCheckbox id="install-df-3" label="Pipelines Auth Configured" />
1921

20-
### Step 4: [Create New Pipelines Repositories](/2.0/docs/pipelines/installation/addingnewrepo)
22+
### Step 4: [Create new Pipelines repositories](/2.0/docs/pipelines/installation/addingnewrepo)
2123

22-
Or alternatively [Add Pipelines To An Existing Repository](/2.0/docs/pipelines/installation/addingexistingrepo).
24+
Alternatively, you can [add Pipelines to an existing repository](/2.0/docs/pipelines/installation/addingexistingrepo).
2325

2426
<PersistentCheckbox id="install-df-4" label="Pipelines Repositories Ready" />
2527

26-
### Step 5: [Configure Account Factory](/2.0/reference/accountfactory/configurations).
28+
### Step 5: [Configure Account Factory](/2.0/reference/accountfactory/configurations)
2729

28-
As part of your Pipelines installation, you will now have Gruntwork Account Factory
30+
During the Pipelines setup process, configure Gruntwork Account Factory for AWS account management.
2931

3032
<PersistentCheckbox id="install-df-5" label="Account Factory Configured" />
3133

32-
### Step 6: Start Using DevOps Foundations
34+
### Step 6: Start using DevOps Foundations
3335

34-
That's it! You're ready to [build with Gruntwork IaC Library](/2.0/docs/library/tutorials/deploying-your-first-gruntwork-module) automatically [plan and apply IaC changes with Pipelines](/2.0/docs/pipelines/guides/running-plan-apply), [vend new AWS Accounts with Account Factory](/2.0/docs/accountfactory/guides/vend-aws-account), and [keep your infrastructure up to date with Patcher](/2.0/docs/patcher/concepts/).
36+
You're all set! You can now:
37+
- [Build with the Gruntwork IaC Library](/2.0/docs/library/tutorials/deploying-your-first-gruntwork-module)
38+
- Automatically [plan and apply IaC changes with Pipelines](/2.0/docs/pipelines/guides/running-plan-apply)
39+
- [Vend new AWS accounts with Account Factory](/2.0/docs/accountfactory/guides/vend-aws-account)
40+
- [Keep your infrastructure up to date with Patcher](/2.0/docs/patcher/concepts/)

docs/2.0/docs/overview/getting-started/invite-team.md

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,44 @@
11
# Invite Your Team
22

3-
All members of your team with an admin role have the ability to manage team membership. The first admin will also be prompted to invite their team immediately after signing in for the first time.
4-
3+
Team members with an admin role can manage team membership. The first admin will also be prompted to invite their team immediately after signing in for the first time.
54

65
## Inviting team members
76

8-
Invite team members to grant them access to the portal and all resources included in your Gruntwork Subscription.
7+
Invite team members to give them access to the portal and all resources included in your Gruntwork subscription.
98

109
1. Navigate to the **[Team](https://app.gruntwork.io/team)** page of the Gruntwork Developer Portal.
11-
2. Click the **Invite** button. A new row will appear beneath the table of team members.
12-
3. Enter the email address of the person you’d like to invite.
13-
4. Select the appropriate role for this team member. All members get access to Gruntwork resources. Admins may additionally manage account information and team membership. (If you accidentally invite someone with the wrong role, you can change it even after the invite has been sent.)
10+
2. Click the **Invite** button. A new row will appear below the table of team members.
11+
3. Enter the email address of the person you wish to invite.
12+
4. Select the appropriate role for the team member. All members can access Gruntwork resources. Admins can additionally manage account information and team membership. (If you assign the wrong role, you can change it even after the invite has been sent.)
1413
5. Press `ENTER` or click the arrow at the right of the row.
1514

16-
This will send an invitation to the provided email address. You can continue inviting additional team members by repeating steps 3–5. If any errors are encountered, an error icon will appear at the right of the row, and you’ll have the opportunity to edit the email and retry as needed.
15+
This will send an invitation to the provided email address. To invite additional team members, repeat steps 3–5. If an error occurs, an error icon will appear at the right of the row, allowing you to edit the email and retry.
1716

18-
## Changing User Roles
17+
## Changing user roles
1918

20-
Admins can change the role of any team member at any time, including those who haven’t yet accepted their invitation. As such, it’s possible to make a correction if you invited a team member with the wrong role.
19+
Admins can change the role of any team member at any time, including those who haven’t accepted their invitation. This allows you to correct any mistakes made during the invitation process.
2120

22-
1. Locate the team member in the table who’s role you wish to change.
21+
1. Locate the team member in the table whose role you wish to change.
2322
2. Click on their current role.
2423
3. Select a new role.
2524

26-
This change will take effect immediately. Any team members who have accepted their invitation will receive an email notifying them of this change.
25+
The change will take effect immediately. Team members who have already accepted their invitation will receive an email notification about the role update.
2726

2827
## Removing team members
2928

30-
Remove team members to free up licenses when they no longer require access to Gruntwork resources. You can also revoke outstanding invitations with the same steps. Once removed from the team, the user will no longer be able to sign in to the Gruntwork Developer portal, nor access Gruntwork resources such as the IaC Library or Teachable video training courses.
29+
Remove team members to free up licenses when they no longer require access to Gruntwork resources. You can also revoke pending invitations using the same process. Once removed, the user will no longer be able to sign in to the Gruntwork Developer Portal or access resources such as the IaC Library or KodeKloud video training courses.
3130

3231
1. Locate the team member you wish to remove in the table.
33-
2. Hover over the row, then click the red remove button at the right of the row.
34-
3. Confirm that you wish to remove them from the team and revoke their access.
35-
36-
This change will take effect immediately. Any team members who have accepted their invitation will receive an email notifying them that they have been removed from the team, and will no longer be able to sign in or access Gruntwork resources.
32+
2. Hover over the row and click the red remove button on the right.
33+
3. Confirm the removal to revoke their access.
3734

35+
The change will take effect immediately. If the removed team member has already accepted their invitation, they will receive an email notifying them that their access has been revoked.
3836

3937
## Requesting additional licenses
4038

41-
The number of licenses available depends on the level of your subscription. You can see the total number of licenses as well as the number remaining at the top of the [Team](https://app.gruntwork.io/team) page. If you need to invite more team members than your current license limit allows, you may request additional licenses, which are billed at a standard monthly rate. To do so, contact [email protected].
39+
The number of licenses available depends on your subscription level. You can view the total and remaining licenses at the top of the [Team](https://app.gruntwork.io/team) page. If you need to invite more team members than your current license limit allows, you can request additional licenses at a standard monthly rate. Contact [email protected] to request more licenses.
4240

43-
## Related Knowledge Base Discussions
41+
## Related knowledge base discussions
4442

4543
- [Invitation to the Developer Portal not received](https://github.com/orgs/gruntwork-io/discussions/716)
4644
- [Trouble logging into the Portal with email](https://github.com/orgs/gruntwork-io/discussions/395)

docs/2.0/docs/overview/getting-started/link-github-id.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,33 +2,34 @@
22
pagination_next: 2.0/docs/overview/getting-started/index
33
---
44

5-
# Link Your GitHub Account
5+
# Link Your GitHub account
66

7-
Gruntwork provides all code included in your subscription through GitHub. You need to link a GitHub ID to your Gruntwork Developer Portal account in order to access the IaC Library on GitHub. Follow the steps below to link your GitHub ID.
7+
Gruntwork provides all code included in your subscription through GitHub. To access the IaC Library on GitHub, you must link your GitHub ID to your Gruntwork Developer Portal account. Follow these steps to complete the process:
88

9-
1. First, sign in to the [Gruntwork Developer Portal](https://app.gruntwork.io).
10-
2. Click the **Link my GitHub Account** button in the notice at the top of the home page, or the corresponding button located in your [Profile Settings](https://app.gruntwork.io/settings/profile).
11-
3. Sign in to your GitHub account, then click the **Authorize** button to confirm the connection.
12-
4. After being redirected back to the Gruntwork Developer Portal, click the **Accept My Invite** button. This will take you to GitHub again, where you can accept an invitation to join the Gruntwork organization. (You can ignore the corresponding invite email you receive from GitHub.)
13-
5. Click **Join Gruntwork** to accept the invitation and access the IaC Library.
9+
1. Sign in to the [Gruntwork Developer Portal](https://app.gruntwork.io).
10+
2. Click the **Link my GitHub Account** button, either in the notice at the top of the home page or in your [Profile Settings](https://app.gruntwork.io/settings/profile).
11+
3. Sign in to your GitHub account and click the **Authorize** button to confirm the connection.
12+
4. After being redirected back to the Gruntwork Developer Portal, click the **Accept My Invite** button. This will return you to GitHub, where you can accept an invitation to join the Gruntwork organization. (You can disregard the corresponding email invitation from GitHub.)
13+
5. Click **Join Gruntwork** to accept the invitation and gain access to the IaC Library.
1414

1515
:::info
1616

17-
Once you’ve linked your account, the notice on the home page will disappear and you’ll find your GitHub ID recorded in your [Profile Settings](https://app.gruntwork.io/settings/profile). Going forward, you’ll have access to all private repositories included in your subscription. If you haven’t done so yet, we strongly recommend [adding an SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) to your GitHub account. An SSH key is required to access the Gruntwork IaC library without adding a password in your Terraform code.
17+
Once your account is linked, the notice on the home page will disappear, and your GitHub ID will be recorded in your [Profile Settings](https://app.gruntwork.io/settings/profile). You will then have access to all private repositories included in your subscription. If you haven’t done so already, we strongly recommend [adding an SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) to your GitHub account. This is required to access the Gruntwork IaC library without entering a password in your OpenTofu/Terraform code.
1818

1919
:::
2020

2121
:::note
2222

23-
[GitHub has begun requiring](https://github.blog/2023-03-09-raising-the-bar-for-software-security-github-2fa-begins-march-13) users to enable two-factor authentication (2FA). If you haven't already done so, we recommend [enabling 2FA](https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication) for your account and any machine users. For more information on the benefits of two-factor authentication and how this change may impact you, please take a look at our [Knowledge Base article](https://github.com/orgs/gruntwork-io/discussions/764).
23+
[GitHub now requires](https://github.blog/2023-03-09-raising-the-bar-for-software-security-github-2fa-begins-march-13) users to enable two-factor authentication (2FA). If you havent already, we recommend [enabling 2FA](https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication) for your account and any machine users. For more details on 2FA benefits and potential impacts, see our [Knowledge Base article](https://github.com/orgs/gruntwork-io/discussions/764).
2424

2525
:::
2626

27-
## Next Steps
2827

29-
Now that you've completed setting up your Gruntwork account, return to the [DevOps Foundations Getting Started Checklist](/2.0/docs/overview/getting-started/index.md) to continue setting up your DevOps Foundations.
28+
## Next steps
3029

31-
## Related Knowledge Base Discussions
30+
Now that you’ve linked your GitHub account, return to the [DevOps Foundations Getting Started Checklist](/2.0/docs/overview/getting-started/index.md) to continue setting up your DevOps Foundations.
31+
32+
## Related knowledge base discussions
3233

3334
- [I have linked my GitHub Account but do not have code access](https://github.com/orgs/gruntwork-io/discussions/715)
3435
- [How can I change my GitHub account (unlink/link)?](https://github.com/orgs/gruntwork-io/discussions/713)

0 commit comments

Comments
 (0)