This repository has been archived by the owner on Aug 1, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 347
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
10 changed files
with
421 additions
and
3,214 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,61 +1,6 @@ | ||
# Contributing Guidelines | ||
|
||
Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional | ||
documentation, we greatly value feedback and contributions from our community. | ||
|
||
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary | ||
information to effectively respond to your bug report or contribution. | ||
|
||
|
||
## Reporting Bugs/Feature Requests | ||
|
||
We welcome you to use the GitHub issue tracker to report bugs or suggest features. | ||
|
||
When filing an issue, please check [existing open](https://github.com/aws-samples/aws-cdk-intro-workshop/issues), or [recently closed](https://github.com/aws-samples/aws-cdk-intro-workshop/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already | ||
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful: | ||
|
||
* A reproducible test case or series of steps | ||
* The version of our code being used | ||
* Any modifications you've made relevant to the bug | ||
* Anything unusual about your environment or deployment | ||
|
||
|
||
## Contributing via Pull Requests | ||
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that: | ||
|
||
1. You are working against the latest source on the *master* branch. | ||
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already. | ||
3. You open an issue to discuss any significant work - we would hate for your time to be wasted. | ||
|
||
To send us a pull request, please: | ||
|
||
1. Fork the repository. | ||
2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change. | ||
3. Ensure local tests pass. | ||
4. Commit to your fork using clear commit messages. | ||
5. Send us a pull request, answering any default questions in the pull request interface. | ||
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation. | ||
|
||
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and | ||
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/). | ||
|
||
|
||
## Finding contributions to work on | ||
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/aws-samples/aws-cdk-intro-workshop/labels/help%20wanted) issues is a great place to start. | ||
|
||
|
||
## Code of Conduct | ||
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). | ||
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact | ||
opensource-codeofconduct@amazon.com with any additional questions or comments. | ||
|
||
|
||
## Security issue notifications | ||
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue. | ||
|
||
|
||
## Licensing | ||
|
||
See the [LICENSE](https://github.com/aws-samples/aws-cdk-intro-workshop/blob/master/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution. | ||
|
||
We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes. | ||
This project has been retired. Please refer to the | ||
[AWS CDK Immersion Day Workshop](https://catalog.us-east-1.prod.workshops.aws/workshops/10141411-0192-4021-afa8-2436f3c66bd8/en-US) | ||
for the latest content. We are not currently accepting contributions or pull | ||
requests. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,129 +1,7 @@ | ||
## Introduction to the AWS Cloud Development Kit (CDK) - Workshop | ||
|
||
## Developer Guide | ||
This workshop has been retired. Please refer to the | ||
[AWS CDK Immersion Day Workshop](https://catalog.us-east-1.prod.workshops.aws/workshops/10141411-0192-4021-afa8-2436f3c66bd8/en-US) | ||
for the latest content. | ||
|
||
This workshop is built with markdown as a static HTML site using [hugo](http://gohugo.io). | ||
|
||
### Installing Hugo | ||
|
||
Because we use asset pipelines and some integrity stamping techniques, we need the "extended" edition. | ||
(This is the recommended version by Hugo themselves, but it's worth pointing out.) | ||
|
||
On MacOS, you can install it straight from Brew: | ||
|
||
```bash | ||
$ brew install hugo | ||
``` | ||
|
||
There are [installation instructions](https://gohugo.io/installation/) available from the Hugo documentation, | ||
however the short form is "Download the latest extended version from [the releases page](https://github.com/gohugoio/hugo/releases/latest) and put the | ||
binary in your PATH somewhere". | ||
|
||
All else fails, follow the installation instructions. As long as you have the Extended hugo release, it's all good. | ||
|
||
### Theme | ||
|
||
This is built off the [Hugo-Book](https://github.com/alex-shpak/hugo-book) theme, lightly modified to suit our needs. | ||
A point of note is that this *Should* eventually be moved to a git submodule, but there's changes that need to be upstreamed. | ||
|
||
Notably: | ||
|
||
* Upstream does not use any [Subresource Integrity](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity) checking. This is done out of paranoia | ||
* Upstream still has a small handful of inline styles (which I've worked hard to remove) | ||
|
||
### Building locally | ||
|
||
You'll find the content of the workshop in the [workshop/](workshop/) directory. | ||
|
||
You can start up a local development server by running: | ||
|
||
```bash | ||
$ cd workshop | ||
$ hugo serve | ||
``` | ||
|
||
open http://localhost:1313/ and you'll have the workshop as it stands. | ||
|
||
### Adding translations & localization. | ||
|
||
Adding a translation means | ||
|
||
* Copying the content from `workshop/content/en/` into your own directory (`workshop/content/xx`) | ||
* Translating the content | ||
* Adding a configuration for your language in `workshop/config.toml` | ||
* Adding a translation file for all appropriate legal terms in the `workshop/i18n/xx.yml` file, copied from `en.yml` | ||
|
||
**The last part is important**! We need to have a translation for | ||
|
||
* "Privacy", "Site Terms" | ||
|
||
And we *Should* have a translation for | ||
|
||
* The cookie banner message | ||
* the cookie banner *actions*. | ||
|
||
These will fall back to the English ones (such as in the JP one) and the link will go to the appropriate-enough regional terms and privacy pages. | ||
|
||
**If your language needs special fonts** in order to render correctly, you should add them in the localization file. | ||
For example, the Japanese localization uses Noto Sans JP to | ||
make sure that the typography looks good, as well as using | ||
two fixed-width typefaces (Nanum Gothic Coding and M PLUS Rounded 1c) | ||
in order to make the mixed English-Japanese legible for everyone. | ||
|
||
```yaml | ||
- id: fontUrl | ||
translation: "https://fonts.googleapis.com/css2?family=Nanum+Gothic+Coding:wght@400;700&family=M+PLUS+Rounded+1c:wght@400;500;700&family=Noto+Sans+JP:wght@400;500;700&display=swap" | ||
- id: bodyFontFamily | ||
translation: "'Noto Sans JP', sans-serif" | ||
- id: headingFontFamily | ||
translation: "'Noto Sans JP', sans-serif" | ||
- id: codeFontFamily | ||
translation: "'Nanum Gothic Coding' 'M PLUS Rounded 1c', monospace" | ||
``` | ||
There *must* be some backup font included -- The stylesheet will not | ||
provide one for you. As a rule of thumb, Noto makes a good option for | ||
most languages, with `sans-serif` falling back on whatever the browser | ||
can provide most efficiently. Code fonts should be monospace. | ||
|
||
If you can, you want at least the following weights: | ||
|
||
* 400 (used for body text) | ||
* 500 (used for for headlines) | ||
* 700 (used for bold text) | ||
|
||
Do *not* use "artsy" typefaces. According to AWS style guides, we | ||
should be using Ember, but the typeface isn't cleared for hosting on | ||
GitHub. Until then, we'll use Noto Sans as a default where reasonable. | ||
|
||
*The use of serifed headlines is allowed* if the language expects it. | ||
Chinese is monotonous to read when only presented in "sans". To give | ||
a clean distinction between headline and body, CJK languages or any | ||
language which "prefers" a certain type of headline may opt to use | ||
a "serif" (read: alternate style) headline typeface. | ||
|
||
When in doubt, ask a native speaker and look to examples of type in | ||
that language (technical books, newspapers, etc are good starts) to | ||
find guidance in what historically separates headline text from the | ||
body text. AWS customers (and employees!) come from all around the | ||
world, and this is intended to cater to them. | ||
|
||
## Website Infrastructure | ||
|
||
The workshop is available at https://cdkworkshop.com. It's a static website hosted on S3 and served through CloudFront. | ||
|
||
It is implemented as a (_surprise_) CDK application under the `cdkworkshop.com` | ||
directory. | ||
|
||
* `npm install` - bootstrap. | ||
* `npm run build` and `npm run watch` | ||
* `npm run deploy` - build & deploy | ||
|
||
### Auto-deployment | ||
|
||
You shouldn't have to manually deploy: Any commit merged into `main` should cause the site to self-deploy via CodeBuild. | ||
|
||
## License Summary | ||
|
||
This sample code is made available under a modified MIT license. See the LICENSE file. | ||
The content is archived here for reference. |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
{ | ||
"javascript": { | ||
"formatter": { | ||
"trailingCommas": "all", | ||
"quoteStyle": "single", | ||
"indentWidth": 4, | ||
"lineEnding": "lf", | ||
"indentStyle": "space" | ||
} | ||
} | ||
} |
Oops, something went wrong.