Skip to content

Commit 9e5691c

Browse files
authored
Add warning about forking our code (#566)
* Add warning about forking our code Forks of private Gruntwork repos will be deleted if their creator loses access, which can be both unexpected and highly disruptive, so a warning message is now shown.
1 parent 505a49b commit 9e5691c

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

_docs-sources/guides/working-with-code/forking.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,12 @@ The definition of an _Authorized User_ from the Gruntwork Terms of Service does
1414
code. That is, if you create internal forks and give 50 users access to those internal forks, then the Gruntwork
1515
License requires that you pay for 50 Authorized Users.
1616

17+
:::danger
18+
19+
Forks of private repositories (such as IaC library modules included in the Gruntwork subscription) will be permanently deleted if the user who created the fork loses access to the source repository. For instance, this can happen when a user is removed from your team in the Gruntwork Developer Portal. Take caution when creating forks of any Gruntwork modules. We recommend creating pull requests to merge your changes upstream and avoid the need to maintain your fork, or creating a machine user to own any forks which will never be removed from your team.
20+
21+
:::
22+
1723
## How to fork the code
1824

1925
Here is how you fork the code in the Gruntwork Infrastructure as Code Library:

docs/guides/working-with-code/forking.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,12 @@ The definition of an _Authorized User_ from the Gruntwork Terms of Service does
1414
code. That is, if you create internal forks and give 50 users access to those internal forks, then the Gruntwork
1515
License requires that you pay for 50 Authorized Users.
1616

17+
:::danger
18+
19+
Forks of private repositories (such as IaC library modules included in the Gruntwork subscription) will be permanently deleted if the user who created the fork loses access to the source repository. For instance, this can happen when a user is removed from your team in the Gruntwork Developer Portal. Take caution when creating forks of any Gruntwork modules. We recommend creating pull requests to merge your changes upstream and avoid the need to maintain your fork, or creating a machine user to own any forks which will never be removed from your team.
20+
21+
:::
22+
1723
## How to fork the code
1824

1925
Here is how you fork the code in the Gruntwork Infrastructure as Code Library:
@@ -58,6 +64,6 @@ bans all outside sources, then follow the instructions above to fork the code, a
5864
<!-- ##DOCS-SOURCER-START
5965
{
6066
"sourcePlugin": "local-copier",
61-
"hash": "030c7f00ebd4cafb747e934a52bc9170"
67+
"hash": "4e5e16c72ceec51847a5322cda7d5bda"
6268
}
6369
##DOCS-SOURCER-END -->

0 commit comments

Comments
 (0)