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

Darkmode #33

Merged
merged 53 commits into from
Feb 6, 2024
Merged
Show file tree
Hide file tree
Changes from 33 commits
Commits
Show all changes
53 commits
Select commit Hold shift + click to select a range
ed18822
support light/dark mode images
osterman Feb 2, 2024
e901696
optimize readme formatting
osterman Feb 2, 2024
94f1762
spruce up checkboxes
osterman Feb 2, 2024
52aeae2
adjust formatting
osterman Feb 5, 2024
dc5f7c1
fix logic
osterman Feb 5, 2024
05392a5
remove whitespace
osterman Feb 5, 2024
6a0abfb
remove whitespace
osterman Feb 5, 2024
48756d3
convert to using img tags and support video
osterman Feb 5, 2024
c4fb9e1
import strings
osterman Feb 5, 2024
d18484a
fix regex match
osterman Feb 5, 2024
af280b7
rebuild readme
osterman Feb 5, 2024
d8003b8
convert banner image to html
osterman Feb 5, 2024
936998e
update readme
osterman Feb 5, 2024
c0bb2f8
update readme
osterman Feb 5, 2024
2558a43
update readme
osterman Feb 6, 2024
c8cad19
update readme
osterman Feb 6, 2024
c9abe06
fix formatting
osterman Feb 6, 2024
b102440
update readme
osterman Feb 6, 2024
e86a780
update readme
osterman Feb 6, 2024
f9a1676
update readme
osterman Feb 6, 2024
58f16bc
update readme
osterman Feb 6, 2024
e0b4761
update readme
osterman Feb 6, 2024
464b272
update readme
osterman Feb 6, 2024
5142158
update readme
osterman Feb 6, 2024
4ea4042
update readme
osterman Feb 6, 2024
bb74aae
update readme
osterman Feb 6, 2024
eacf2be
update readme
osterman Feb 6, 2024
9855722
update readme
osterman Feb 6, 2024
71bff18
update readme
osterman Feb 6, 2024
7577c26
update readme
osterman Feb 6, 2024
97612b5
update readme
osterman Feb 6, 2024
cca7746
update readme
osterman Feb 6, 2024
0266ab6
update readme
osterman Feb 6, 2024
93c7a4f
update readme
osterman Feb 6, 2024
a0ec7c2
update readme
osterman Feb 6, 2024
00381f3
play with whitespace
osterman Feb 6, 2024
b226107
play with whitespace
osterman Feb 6, 2024
192f7c6
update copy
osterman Feb 6, 2024
3de6f98
update readme
osterman Feb 6, 2024
fe8b973
update readme
osterman Feb 6, 2024
d51eaf1
update readme
osterman Feb 6, 2024
4834136
update readme
osterman Feb 6, 2024
edb148c
update readme
osterman Feb 6, 2024
7b828b9
update readme
osterman Feb 6, 2024
09822ff
update copy
osterman Feb 6, 2024
1fcee37
update readme
osterman Feb 6, 2024
40e0f33
update readme
osterman Feb 6, 2024
c1c3a53
update readme
osterman Feb 6, 2024
7dc800f
update readme
osterman Feb 6, 2024
5b79619
update copy
osterman Feb 6, 2024
dbb306d
update readme
osterman Feb 6, 2024
cbce291
update readme
osterman Feb 6, 2024
32bcd87
fix video tag to supported format
osterman Feb 6, 2024
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
35 changes: 24 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@

<!-- markdownlint-disable -->
[![Project Banner](.github/banner.png?raw=true)](https://cpco.io/homepage)
[![Slack Community](https://slack.cloudposse.com/for-the-badge.svg)](https://slack.cloudposse.com) [![Last Update](https://img.shields.io/github/last-commit/cloudposse/.github/main?style=for-the-badge)](https://github.com/cloudposse/.github/commits/main/)
<a href="https://cpco.io/homepage"><img src=".github/banner.png?raw=true" alt="Project Banner"/></a><br/><p align="right">

<a href="https://github.com/cloudposse/.github/commits/main/"><img src="https://img.shields.io/github/last-commit/cloudposse/.github/main?style=for-the-badge" alt="Last Update"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/for-the-badge.svg" alt="Slack Community"/></a></p>
<!-- markdownlint-restore -->


Expand All @@ -12,7 +13,7 @@

** DO NOT EDIT THIS FILE
**
** This file was automatically generated by the `build-harness`.
** This file was automatically generated by the `cloudposse/build-harness`.
** 1) Make all changes to `README.yaml`
** 2) Run `make init` (you only need to do this once)
** 3) Run`make readme` to rebuild this file.
Expand Down Expand Up @@ -42,9 +43,11 @@ This repository fulfills several unique functions functions for the Cloud Posse
---
> [!NOTE]
> This project is part of Cloud Posse's comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
> <details><summary>Learn More</summary>
>
> It's 100% Open Source and licensed under the [APACHE2](LICENSE).
>
> </details>

[![README Header][readme_header_img]][readme_header_link]

Expand All @@ -67,7 +70,7 @@ To add all repository bootstrapping files to a new repo:

## ✨ Contributing

This project is under active development, and we encourage contributions from our community.
This project is under active development, and we encourage contributions from our community.
Many thanks to our outstanding contributors:

<a href="https://github.com/cloudposse/.github/graphs/contributors">
Expand Down Expand Up @@ -104,21 +107,26 @@ Sign up for [our newsletter][newsletter] that covers everything on our technolog

[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!

## About
## About

This project is maintained and funded by [Cloud Posse, LLC][website].
This project is maintained by [Cloud Posse, LLC][website].
<a href="https://cpco.io/homepage"><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>

We are a [**DevOps Accelerator**][commercial_support]. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.
We are a [**DevOps Accelerator**][commercial_support] for funded startups and enterprises.
Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly.
We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.

[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]

Work directly with our team of DevOps experts via email, slack, and video conferencing.
*Your team can operate like a pro today.*

We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.
Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.

<details>
<summary>📚 What's included?</summary>

- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
- **Deployment Strategy.** You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
Expand All @@ -127,13 +135,17 @@ We deliver 10x the value for a fraction of the cost of a full-time engineer. Our
- **Troubleshooting.** You'll get help to triage when things aren't working.
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
</details>

[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
## License

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge)](https://opensource.org/licenses/Apache-2.0)

See [LICENSE](LICENSE) for full details.
<details>
<summary>Summary of License</summary>

Complete license is available in the [`LICENSE`](LICENSE) file.

```text
Licensed to the Apache Software Foundation (ASF) under one
Expand All @@ -153,6 +165,7 @@ KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
```
</details>

## Trademarks

Expand Down
85 changes: 57 additions & 28 deletions README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,23 @@
{{- defineDatasource "includes" (env.Getenv "README_INCLUDES") -}}
{{- $deprecated := has (ds "config") "deprecated" }}
<!-- markdownlint-disable -->
{{- if $deprecated }}
# (deprecated) {{(ds "config").name}}{{ if gt (len (ds "config").name) 23 }}{{ print "\n\n" }}{{ end }}
{{ if $deprecated -}}
# (deprecated) {{(ds "config").name}}
{{- else }}
{{ if (file.Exists ".github/banner.png") -}}
[![Project Banner](.github/banner.png?raw=true)](https://cpco.io/homepage)
{{ else -}}
# {{(ds "config").name}}<a href="https://cpco.io/homepage"><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a>{{ if gt (len (ds "config").name) 34 }}{{ print "\n\n" }}{{ end }}
{{- end -}}
{{- if (file.Exists ".github/banner.png") -}}
<a href="https://cpco.io/homepage"><img src=".github/banner.png?raw=true" alt="Project Banner"/></a><br/>
{{- if has (ds "config") "badges" -}}<p align="right">{{- end -}}
{{- else -}}
# {{(ds "config").name}} <a href="https://cpco.io/homepage"><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a>
{{- end }}
{{- end }}
{{- if $deprecated }}[![deprecated](https://img.shields.io/badge/lifecycle-deprecated-critical?style=for-the-badge)](#deprecated){{ end }}
{{- if has (ds "config") "badges" -}}
{{- range $badge := (ds "config").badges -}}
{{- printf " [![%s](%s)](%s)" $badge.name $badge.image $badge.url }}
{{- if has (ds "config") "badges" }}
{{ print "\n" }}
{{- range $badge := (ds "config").badges -}}
{{- printf "<a href=\"%s\"><img src=\"%s\" alt=\"%s\"/></a>" $badge.url $badge.image $badge.name -}}
{{- end }}
{{- if (file.Exists ".github/banner.png") -}}</p>{{- end -}}
{{- end }}
<!-- markdownlint-restore -->

Expand All @@ -27,7 +30,7 @@

** DO NOT EDIT THIS FILE
**
** This file was automatically generated by the `build-harness`.
** This file was automatically generated by the `cloudposse/build-harness`.
** 1) Make all changes to `README.yaml`
** 2) Run `make init` (you only need to do this once)
** 3) Run`make readme` to rebuild this file.
Expand Down Expand Up @@ -73,14 +76,31 @@ We literally have [*hundreds of other terraform modules*][terraform_modules] tha
## Screenshots

{{ range $screenshot := (ds "config").screenshots }}
{{ printf "![%s](%s)\n*%s*" $screenshot.name $screenshot.url $screenshot.description }}{{ end }}
{{- if or ( $screenshot.url | regexp.Match "\\.mp4$") ($screenshot.url | regexp.Match "\\.mp4\\?.*") -}}
<video controls>
<source src="{{ $screenshot.url }}" type="video/mp4">
Your browser does not support the video tag.
</video>
{{- else -}}
![{{ $screenshot.name }}]({{ $screenshot.url }})
{{- end -}}
*{{ $screenshot.description }}*
{{ end }}
{{- end }}

---
> [!NOTE]
> This project {{ if $deprecated }}was{{ else }}is{{ end }} part of Cloud Posse's comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
> <details><summary>Learn More</summary>
{{- if (file.Exists "main.tf") }}
> <a href="https://cpco.io/terraform-modules"><img src="https://docs.cloudposse.com/images/terraform-open-source-modules.svg" align="right" /></a>
> <a href="https://cpco.io/terraform-modules">
> <picture>
> <source media="(prefers-color-scheme: dark)" srcset="https://docs.cloudposse.com/images/terraform-open-source-modules-light.svg">
> <source media="(prefers-color-scheme: light)" srcset="https://docs.cloudposse.com/images/terraform-open-source-modules-dark.svg">
> <img alt="Terraform Open Source Modules" src="https://docs.cloudposse.com/images/terraform-open-source-modules.svg" align="right">
> </picture>
> </a>
>
{{- end}}
>
{{- if eq (ds "config").license "APACHE2" }}
Expand All @@ -105,10 +125,10 @@ We literally have [*hundreds of other terraform modules*][terraform_modules] tha
{{- if (file.Exists "main.tf") }}
> We literally have [*hundreds of terraform modules*][terraform_modules] that are Open Source and well-maintained. Check them out!
{{- end }}
> </details>
{{ if not $deprecated }}
[![README Header][readme_header_img]][readme_header_link]
{{- end }}

{{- end }}

{{ if has (ds "config") "introduction" }}
Expand All @@ -122,12 +142,11 @@ We literally have [*hundreds of other terraform modules*][terraform_modules] tha

{{ if (file.Exists "main.tf") }}

> **Important**
> We do not pin modules to versions in Cloud Posse's examples because of the
> difficulty of keeping the versions in the documentation in sync with the latest released versions.
> We highly recommend that in your code you pin the version to the exact version you are
> using so that your infrastructure remains stable, and update versions in a
> systematic way so that they do not catch you by surprise.
> [!IMPORTANT]
> In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation
> and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version
> you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic
> approach for updating versions to avoid unexpected changes.

{{end}}

Expand Down Expand Up @@ -173,7 +192,7 @@ For additional context, refer to some of these links.
{{ if not $deprecated -}}
## ✨ Contributing
{{ if has (datasource "config") "contributors" }}
This project is under active development, and we encourage contributions from our community.
This project is under active development, and we encourage contributions from our community.
Many thanks to our outstanding contributors:

<a href="https://github.com/{{ printf "%s" (ds "config").github_repo}}/graphs/contributors">
Expand Down Expand Up @@ -213,21 +232,26 @@ Sign up for [our newsletter][newsletter] that covers everything on our technolog

{{- end }}

## About
## About

This project is maintained and funded by [Cloud Posse, LLC][website].
This project is maintained by [Cloud Posse, LLC][website].
<a href="https://cpco.io/homepage"><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>

We are a [**DevOps Accelerator**][commercial_support]. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.
We are a [**DevOps Accelerator**][commercial_support] for funded startups and enterprises.
Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly.
We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.

[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]

Work directly with our team of DevOps experts via email, slack, and video conferencing.
*Your team can operate like a pro today.*

We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.
Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.

<details>
<summary>📚 What's included?</summary>

- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
- **Deployment Strategy.** You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
Expand All @@ -236,6 +260,7 @@ We deliver 10x the value for a fraction of the cost of a full-time engineer. Our
- **Troubleshooting.** You'll get help to triage when things aren't working.
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
</details>

[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]

Expand All @@ -244,7 +269,10 @@ We deliver 10x the value for a fraction of the cost of a full-time engineer. Our

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge)](https://opensource.org/licenses/Apache-2.0)

See [LICENSE](LICENSE) for full details.
<details>
<summary>Summary of License</summary>

Complete license is available in the [`LICENSE`](LICENSE) file.

```text
Licensed to the Apache Software Foundation (ASF) under one
Expand All @@ -264,6 +292,7 @@ KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
```
</details>
{{- end }}
{{- if eq (ds "config").license "CC-BY-NC-SA-4.0" }}
## License
Expand Down
6 changes: 3 additions & 3 deletions README.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ github_repo: cloudposse/.github

# Badges to display
badges:
- name: "Slack Community"
image: "https://slack.cloudposse.com/for-the-badge.svg"
url: "https://slack.cloudposse.com"
- name: "Last Update"
image: https://img.shields.io/github/last-commit/cloudposse/.github/main?style=for-the-badge
url: https://github.com/cloudposse/.github/commits/main/
- name: "Slack Community"
image: "https://slack.cloudposse.com/for-the-badge.svg"
url: "https://slack.cloudposse.com"

# Short description of this project
description: |-
Expand Down
6 changes: 3 additions & 3 deletions profile/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@
>
> Use our ready-to-go [terraform architecture blueprints](https://cloudposse.com/services/) for AWS to get up and running quickly.
>
> * We build it with you.
> * You own everything.
> * Your team wins.
> We build it with you.<br/>
> You own everything.<br/>
> Your team wins.<br/>
>
> [![Request Quote](https://img.shields.io/badge/Request_Quote-success.svg?style=for-the-badge)](https://cloudposse.com/quiz/)
>
Expand Down
Loading