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

Minor updates to user docs - concepts #7345

Merged
merged 9 commits into from
Jul 1, 2024
Merged

Conversation

tom-webber
Copy link
Contributor

@tom-webber tom-webber commented Jun 26, 2024

No associated issue. An update to the 'Concept' section of the user guide, and addition of a workflow to run on docs PRs to check whether external links are working.

Also includes:

  • workflow for running broken-link checker when updating user guide, and on regular schedule for readme's across the repo
    • config to exlude status types, login-restricted urls, high-redirect urls, and internal github repos
  • many urls fixed across the repo, where I could find suitable replacements
  • small re-write to terraform/environments/bootstrap/secure-baselines/README.md, as it looked out of date

Checklist (check x in [ ] of list items)

  • I have performed a self-review of my own code
  • All checks have passed
  • I have made corresponding changes to the documentation

Additional comments (if any)

{Please write here}

- sentence flow, headings, capitalisation
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jun 26, 2024
Copy link
Contributor

Trivy Scan Success

Show Output ```hcl

Trivy will check the following folders:

</details> #### `Checkov Scan` Success
<details><summary>Show Output</summary>

```hcl

*****************************

Checkov will check the following folders:

CTFLint Scan Success

Show Output
*****************************

Setting default tflint config...
Running tflint --init...
Installing "terraform" plugin...
Installed "terraform" (source: github.com/terraform-linters/tflint-ruleset-terraform, version: 0.5.0)
tflint will check the following folders:

Trivy Scan Success

Show Output
*****************************

Trivy will check the following folders:


In a shared AWS account for a business unit, untaggable billable items such as Data Transfer become impossible to attribute to an application.
In a shared AWS account for a business unit, untaggable billable items such as Data Transfer cannot easily be attributed to a particular application.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

untaggable billable items such as Data Transfer cannot easily be attributed to a particular application

Is this still the case (I don't have access to any cost allocation billing report to check)? https://repost.aws/questions/QUSiF9OHXiSqmYWZ4BbnAKeA/data-transfer-tagging

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not entirely sure. This may be a comment from an historic perspective. It could now be, with tags and other items included, they can be. As you say access to specifics would be best to check this.

- people tend to go for the easiest option, which creates technical debt further down the line
- infrastructure quickly becomes hard to track
- it can become tangled and messy
- doesn't support the central alignment we're trying to achieve
Copy link
Contributor Author

@tom-webber tom-webber Jun 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

doesn't support the central alignment we're trying to achieve

I'd prefer to reword this *that this be reworded, as it's not clear to me exactly what this means

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you feel this needs to be reworded you could send out an example to the whole team to see if anyone has complaints/suggestions.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally? This is an early way of describing what P&A exists to do through hosting teams.

Copy link
Contributor

Trivy Scan Success

Show Output ```hcl

Trivy will check the following folders:

</details> #### `Checkov Scan` Success
<details><summary>Show Output</summary>

```hcl

*****************************

Checkov will check the following folders:

CTFLint Scan Success

Show Output
*****************************

Setting default tflint config...
Running tflint --init...
Installing "terraform" plugin...
Installed "terraform" (source: github.com/terraform-linters/tflint-ruleset-terraform, version: 0.5.0)
tflint will check the following folders:

Trivy Scan Success

Show Output
*****************************

Trivy will check the following folders:

Copy link
Contributor

Trivy Scan Success

Show Output ```hcl

Trivy will check the following folders:

</details> #### `Checkov Scan` Success
<details><summary>Show Output</summary>

```hcl

*****************************

Checkov will check the following folders:

CTFLint Scan Success

Show Output
*****************************

Setting default tflint config...
Running tflint --init...
Installing "terraform" plugin...
Installed "terraform" (source: github.com/terraform-linters/tflint-ruleset-terraform, version: 0.5.0)
tflint will check the following folders:

Trivy Scan Success

Show Output
*****************************

Trivy will check the following folders:

Copy link
Contributor

Trivy Scan Success

Show Output ```hcl

Trivy will check the following folders:

</details> #### `Checkov Scan` Success
<details><summary>Show Output</summary>

```hcl

*****************************

Checkov will check the following folders:

CTFLint Scan Success

Show Output
*****************************

Setting default tflint config...
Running tflint --init...
Installing "terraform" plugin...
Installed "terraform" (source: github.com/terraform-linters/tflint-ruleset-terraform, version: 0.5.0)
tflint will check the following folders:

Trivy Scan Success

Show Output
*****************************

Trivy will check the following folders:

Copy link
Contributor

Trivy Scan Success

Show Output ```hcl

Trivy will check the following folders:

</details> #### `Checkov Scan` Success
<details><summary>Show Output</summary>

```hcl

*****************************

Checkov will check the following folders:

CTFLint Scan Success

Show Output
*****************************

Setting default tflint config...
Running tflint --init...
Installing "terraform" plugin...
Installed "terraform" (source: github.com/terraform-linters/tflint-ruleset-terraform, version: 0.5.0)
tflint will check the following folders:

Trivy Scan Success

Show Output
*****************************

Trivy will check the following folders:

@@ -1,6 +1,13 @@
# Modernisation Platform: environments bootstrapping
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this README might have been intended for the parent directory (terraform/environments/bootstrap)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. Feel free to move it!

@tom-webber tom-webber marked this pull request as ready for review June 28, 2024 14:20
@tom-webber tom-webber requested a review from a team as a code owner June 28, 2024 14:20
Copy link
Contributor

Trivy Scan Success

Show Output ```hcl

Trivy will check the following folders:

</details> #### `Checkov Scan` Success
<details><summary>Show Output</summary>

```hcl

*****************************

Checkov will check the following folders:

CTFLint Scan Success

Show Output
*****************************

Setting default tflint config...
Running tflint --init...
Installing "terraform" plugin...
Installed "terraform" (source: github.com/terraform-linters/tflint-ruleset-terraform, version: 0.5.0)
tflint will check the following folders:

Trivy Scan Success

Show Output
*****************************

Trivy will check the following folders:

Copy link
Contributor

github-actions bot commented Jul 1, 2024

Trivy Scan Success

Show Output ```hcl

Trivy will check the following folders:

</details> #### `Checkov Scan` Success
<details><summary>Show Output</summary>

```hcl

*****************************

Checkov will check the following folders:

CTFLint Scan Success

Show Output
*****************************

Setting default tflint config...
Running tflint --init...
Installing "terraform" plugin...
Installed "terraform" (source: github.com/terraform-linters/tflint-ruleset-terraform, version: 0.5.0)
tflint will check the following folders:

Trivy Scan Success

Show Output
*****************************

Trivy will check the following folders:

@tom-webber tom-webber added this pull request to the merge queue Jul 1, 2024
Merged via the queue into main with commit d7f8889 Jul 1, 2024
11 of 13 checks passed
@tom-webber tom-webber deleted the upd/tweaks-to-user-docs branch July 1, 2024 11:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation github-workflow
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants