You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+8-11
Original file line number
Diff line number
Diff line change
@@ -15,19 +15,21 @@ However while we want to be as comprehensive as possible, we also want to make s
15
15
The guide is split up in the following way:
16
16
17
17
The Basics:
18
+
18
19
- The basic aspects of creating a full-stack serverless app. And deploying your app to production.
19
20
20
21
Best Practices:
22
+
21
23
- Everything you need to run your app in production.
22
24
23
25
The Extensions
26
+
24
27
- Extra Credits: Standalone chapters/articles intended to supplement the first two parts and to extend some functionality of the demo app.
25
28
26
29
Additionally, the demo app that people build as a part of the tutorial is split into the backend (a Serverless Framework project) and the frontend (a React app). Both these are in their separate Git repos.
27
30
28
31
Key chapters in the Core part of the guide are accompanied with branches in their respective demo app repos. This is used to track progress and as a reference as you work through the tutorial.
29
32
30
-
31
33
## How to Help
32
34
33
35
There are quite a few ways to help.
@@ -41,7 +43,6 @@ There are quite a few ways to help.
41
43
42
44
Additionally, you are welcome to provide general feedback and suggestions via our forums.
43
45
44
-
45
46
### Keep the core guide updated
46
47
47
48
The SST Guide is reliant on a large number of services and open source libraries and projects. Here is what needs updating:
@@ -71,7 +72,6 @@ For the steps in the tutorial:
71
72
72
73
Once all the PRs are merged, we'll tag the repo (tutorial & demo app) with the new version number and update the Changelog chapter.
73
74
74
-
75
75
### Add an Extra Credit Chapter
76
76
77
77
The core chapters are missing some extra details (for the sake of simplicity) that are necessary once you start customizing SST setup. Additionally, there are cases that we just don't handle in the core chapters. [Here is a rough list of topics that have been requested](https://github.com/AnomalyInnovations/serverless-stack-com/projects/1#column-2785572). This is not an exhaustive list. If you have some ideas to extend some of the demo app functionality, feel free to get in touch with us. Here is how to go about adding a new extra credit chapter:
@@ -95,7 +95,6 @@ For any changes to the demo app:
95
95
96
96
Finally, submit a PR to the tutorial repo with the new changes. We'll review it, maybe suggest some edits or give you some feedback. Once everything looks okay we'll merge with master and publish it. We'll also create comments threads for your chapter in the forums and link to it.
97
97
98
-
99
98
### Improve Tooling
100
99
101
100
Currently we do a lot of manual work to publish updates and maintain the tutorial. You can help by contributing to improve the process. Feel free to get in touch if you're interested in helping out. Here is roughly what we need help with:
@@ -116,11 +115,11 @@ To translate a chapter follow these steps:
116
115
117
116
1. Add the following to the frontmatter of the chapter you intend to translate.
118
117
119
-
```yml
118
+
```yml
120
119
ref: uri-of-the-chapter
121
120
lang: en
122
121
```
123
-
122
+
124
123
Here `uri-of-the-chapter` is the part of the url that represents the name of the chapter. For example, the [What is Serverless](https://sst.dev/chapters/what-is-serverless.html) has a URI `what-is-serverless`.
125
124
126
125
2. Copy the file to `_chapters/[language-code]/[filename].md`
@@ -129,12 +128,11 @@ To translate a chapter follow these steps:
129
128
130
129
3. Change the frontmatter to.
131
130
132
-
```yml
131
+
```yml
133
132
lang: language-code
134
133
```
135
-
134
+
136
135
Again the `language-code` is either `pt` or `es`.
137
-
138
136
139
137
Note that the only thing linking the translation with the original is the `ref:` attribute in the frontmatter. Make sure that it is the same for both the files.
140
138
@@ -144,6 +142,5 @@ As an example, compare the [What is Serverless](https://sst.dev/chapters/what-is
The [SST Guide](https://sst.dev/guide.html) is a comprehensive open source tutorial for building and deploying full-stack apps using Serverless and React on AWS.
16
16
@@ -20,7 +20,7 @@ We are going to create a [note taking app](https://demo.sst.dev) from scratch us
20
20
21
21
It is a single-page React app powered by a serverless CRUD API. We also cover how add user authentication and handle file uploads.
22
22
23
-
The entire guide is hosted on GitHub and we use [Discourse][Discourse] for our comments. With the help of the community we add more detail to the guide and keep it up to date.
23
+
The entire guide is hosted on GitHub and we use [Discourse][discourse] for our comments. With the help of the community we add more detail to the guide and keep it up to date.
24
24
25
25
## Project Goals
26
26
@@ -31,10 +31,10 @@ The entire guide is hosted on GitHub and we use [Discourse][Discourse] for our c
31
31
32
32
## Getting Help
33
33
34
-
- If you are running into issues with a specific chapter, post in the comments for that [chapter][Discourse].
34
+
- If you are running into issues with a specific chapter, post in the comments for that [chapter][discourse].
35
35
- Open a [new issue](../../issues/new) if you've found a bug
36
-
- Or if you have a suggestion create a [new topic][Discourse] in our forums
37
-
- If you've found a typo, edit the chapter and submit a [pull request][PR].
36
+
- Or if you have a suggestion create a [new topic][discourse] in our forums
37
+
- If you've found a typo, edit the chapter and submit a [pull request][pr].
38
38
39
39
## Source for the Demo App
40
40
@@ -44,7 +44,7 @@ We also have an alternative Serverless Framework version: [backend serverless AP
44
44
45
45
## Contributing
46
46
47
-
Thank you for your considering to contribute. [Read more about how you can contribute to SST][Contributing].
47
+
Thank you for your considering to contribute. [Read more about how you can contribute to SST][contributing].
48
48
49
49
## Running Locally
50
50
@@ -54,36 +54,36 @@ SST is built using [Jekyll](https://jekyllrb.com). [Follow these steps to instal
54
54
55
55
To install, run the following in the root of the project.
56
56
57
-
```bash
57
+
```bash
58
58
$ bundle install
59
59
```
60
60
61
61
And to view locally.
62
62
63
-
```bash
63
+
```bash
64
64
$ bundle exec jekyll serve
65
65
```
66
66
67
67
You can now view the guide locally by visiting `http://localhost:4000/`.
68
68
69
69
You can also turn on live reloading and incremental builds while editing.
0 commit comments