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

Content: Accessing the Developer Portal #73

Merged
merged 2 commits into from
Dec 3, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions _docs-sources/intro/dev-portal/create-account.md
Original file line number Diff line number Diff line change
@@ -1 +1,25 @@
# Create Your Account

The Gruntwork Developer Portal provides access to all resources included in your Gruntwork subscription. Activating your account will grant access to our DevOps training courses and the Gruntwork Service Catalog. Admins can also manage their team and invite additional members.

## 1. Accept your invitation

You'll receive an invitation email from `grunty@gruntwork.io` prompting you to sign in and set up your account. Click on the button in the invitation email.

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**.

## 2. Confirm your email address

You'll be prompted to check your inbox for a sign in email. Gruntwork uses an passwordless email authentication flow each time you sign in. Just click the link in the sign in email to finish signing in.

:::note

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.

:::

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.

## 3. Provide account details

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.
40 changes: 40 additions & 0 deletions _docs-sources/intro/dev-portal/invite-team.md
Original file line number Diff line number Diff line change
@@ -1 +1,41 @@
# Invite Your Team

All members of the org with an admin role have the ability to manage team membership. The first admin will also be prompted to invite their team immeditely after signing in to the portal for the first time.


## Inviting team members

Invite team members to grant them access to the portal and all recourses included in your Gruntwork Subscription.

1. Navigate to the **[Team](https://app.gruntwork.io/team)** page of the Gruntwork Developer Portal.
2. Click the **Invite** button. A new row will appear beneath the table of team members.
3. Enter the email address of the person you'd like to invite.
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.)
5. Press `ENTER` or click the arrow at the right of the row.

This will send an invitation to the provided email address. You can continue entering additional emails to invite, repeating steps 3–5. If any errors are encountered, an error icon will apear at the right of the row, and you'll have the opportunity to adjust the email and retry as needed.

## Changing User Roles

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.

1. Locate the team member in the table who's role you wish to change.
2. Click on their current role.
3. Select a new role.

This change will take effect immediately. Any team members who have accepted their invitation will receive an email notifying them of this change.

## Removing team members

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, they will no longer be able to sign in to the Gruntwork Developer portal, nor access Gruntwork resources such as the Service Catalog or Teachable video training courses.

1. Locate the team member you wish to remove in the table.
2. Hover over the row, then click the red remove button at the right of the row.
3. Confirm that you wish to remove them from the team and revoke their access.

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.


## Requesting additional licenses

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 licenese, which are billed at a standard monthly rate. To do so, contact sales@gruntwork.io.
22 changes: 22 additions & 0 deletions _docs-sources/intro/dev-portal/link-github-id.md
Original file line number Diff line number Diff line change
@@ -1 +1,23 @@
# Link Your GitHub ID

Gruntwork provides all code included in the subscription through GitHub. You'll need to link a GitHub ID to your account in order to access the IaC Catalog on GitHub. Follow the steps below to link your GitHub ID.

## Linking your GitHub account

1. First, sign in to the Gruntwork Developer Portal.
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).
3. Sign in to your GitHub account, then click the **Authorize** button to confirm the connection.
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.)
5. Click **Join Gruntwork** to accept the invitation and access the IaC catalog.

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.


## Linking a new GitHub account

To link a new GitHub ID, you'll first have to unlink the current one. Although uncommon, note that any private forks of Gruntwork repos will be deleted when you unlink your account.

1. Sign in to the Gruntwork Developer Portal and navigate to your [Profile Settings](https://app.gruntwork.io/settings/profile).
2. Click **Unlink** in the description under the **GitHub Account** section.
3. Click **Yes, Unlink My Account** in the confirmation dialog that appears.
4. Proceed with the [steps above](#linking-your-github-id) to link a new GitHub account.
26 changes: 25 additions & 1 deletion docs/intro/dev-portal/create-account.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,30 @@
# Create Your Account

The Gruntwork Developer Portal provides access to all resources included in your Gruntwork subscription. Activating your account will grant access to our DevOps training courses and the Gruntwork Service Catalog. Admins can also manage their team and invite additional members.

## 1. Accept your invitation

You'll receive an invitation email from `grunty@gruntwork.io` prompting you to sign in and set up your account. Click on the button in the invitation email.

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**.

## 2. Confirm your email address

You'll be prompted to check your inbox for a sign in email. Gruntwork uses an passwordless email authentication flow each time you sign in. Just click the link in the sign in email to finish signing in.

:::note

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.

:::

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.

## 3. Provide account details

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.


<!-- ##DOCS-SOURCER-START
{"sourcePlugin":"Local File Copier","hash":"abb5b0695e71cb31858cedd66e5dd30c"}
{"sourcePlugin":"Local File Copier","hash":"089bac3903377b3729ecef08fbb206f7"}
##DOCS-SOURCER-END -->
42 changes: 41 additions & 1 deletion docs/intro/dev-portal/invite-team.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,46 @@
# Invite Your Team

All members of the org with an admin role have the ability to manage team membership. The first admin will also be prompted to invite their team immeditely after signing in to the portal for the first time.


## Inviting team members

Invite team members to grant them access to the portal and all recourses included in your Gruntwork Subscription.

1. Navigate to the **[Team](https://app.gruntwork.io/team)** page of the Gruntwork Developer Portal.
2. Click the **Invite** button. A new row will appear beneath the table of team members.
3. Enter the email address of the person you'd like to invite.
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.)
5. Press `ENTER` or click the arrow at the right of the row.

This will send an invitation to the provided email address. You can continue entering additional emails to invite, repeating steps 3–5. If any errors are encountered, an error icon will apear at the right of the row, and you'll have the opportunity to adjust the email and retry as needed.

## Changing User Roles

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.

1. Locate the team member in the table who's role you wish to change.
2. Click on their current role.
3. Select a new role.

This change will take effect immediately. Any team members who have accepted their invitation will receive an email notifying them of this change.

## Removing team members

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, they will no longer be able to sign in to the Gruntwork Developer portal, nor access Gruntwork resources such as the Service Catalog or Teachable video training courses.

1. Locate the team member you wish to remove in the table.
2. Hover over the row, then click the red remove button at the right of the row.
3. Confirm that you wish to remove them from the team and revoke their access.

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.


## Requesting additional licenses

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 licenese, which are billed at a standard monthly rate. To do so, contact sales@gruntwork.io.


<!-- ##DOCS-SOURCER-START
{"sourcePlugin":"Local File Copier","hash":"1d33dde53f0682859b15ac8c3a0890e0"}
{"sourcePlugin":"Local File Copier","hash":"b7c4239a30a1aa37b032c30c9dc11b50"}
##DOCS-SOURCER-END -->
24 changes: 23 additions & 1 deletion docs/intro/dev-portal/link-github-id.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,28 @@
# Link Your GitHub ID

Gruntwork provides all code included in the subscription through GitHub. You'll need to link a GitHub ID to your account in order to access the IaC Catalog on GitHub. Follow the steps below to link your GitHub ID.

## Linking your GitHub account

1. First, sign in to the Gruntwork Developer Portal.
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).
3. Sign in to your GitHub account, then click the **Authorize** button to confirm the connection.
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.)
5. Click **Join Gruntwork** to accept the invitation and access the IaC catalog.

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.


## Linking a new GitHub account

To link a new GitHub ID, you'll first have to unlink the current one. Although uncommon, note that any private forks of Gruntwork repos will be deleted when you unlink your account.

1. Sign in to the Gruntwork Developer Portal and navigate to your [Profile Settings](https://app.gruntwork.io/settings/profile).
2. Click **Unlink** in the description under the **GitHub Account** section.
3. Click **Yes, Unlink My Account** in the confirmation dialog that appears.
4. Proceed with the [steps above](#linking-your-github-id) to link a new GitHub account.


<!-- ##DOCS-SOURCER-START
{"sourcePlugin":"Local File Copier","hash":"0204fbe00bb0c375d92bb4d13aaeefef"}
{"sourcePlugin":"Local File Copier","hash":"9b796e6fe9a0c45cc26731450b664f36"}
##DOCS-SOURCER-END -->