Skip to content

Commit deb6388

Browse files
committed
Updating
1 parent 4b12c3e commit deb6388

File tree

5 files changed

+26
-31
lines changed

5 files changed

+26
-31
lines changed

CONTRIBUTING.md

+8-11
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,21 @@ However while we want to be as comprehensive as possible, we also want to make s
1515
The guide is split up in the following way:
1616

1717
The Basics:
18+
1819
- The basic aspects of creating a full-stack serverless app. And deploying your app to production.
1920

2021
Best Practices:
22+
2123
- Everything you need to run your app in production.
2224

2325
The Extensions
26+
2427
- Extra Credits: Standalone chapters/articles intended to supplement the first two parts and to extend some functionality of the demo app.
2528

2629
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.
2730

2831
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.
2932

30-
3133
## How to Help
3234

3335
There are quite a few ways to help.
@@ -41,7 +43,6 @@ There are quite a few ways to help.
4143

4244
Additionally, you are welcome to provide general feedback and suggestions via our forums.
4345

44-
4546
### Keep the core guide updated
4647

4748
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:
7172

7273
Once all the PRs are merged, we'll tag the repo (tutorial & demo app) with the new version number and update the Changelog chapter.
7374

74-
7575
### Add an Extra Credit Chapter
7676

7777
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:
9595

9696
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.
9797

98-
9998
### Improve Tooling
10099

101100
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:
116115

117116
1. Add the following to the frontmatter of the chapter you intend to translate.
118117

119-
``` yml
118+
```yml
120119
ref: uri-of-the-chapter
121120
lang: en
122121
```
123-
122+
124123
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`.
125124

126125
2. Copy the file to `_chapters/[language-code]/[filename].md`
@@ -129,12 +128,11 @@ To translate a chapter follow these steps:
129128

130129
3. Change the frontmatter to.
131130

132-
``` yml
131+
```yml
133132
lang: language-code
134133
```
135-
134+
136135
Again the `language-code` is either `pt` or `es`.
137-
138136

139137
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.
140138

@@ -144,6 +142,5 @@ As an example, compare the [What is Serverless](https://sst.dev/chapters/what-is
144142
- Spanish version: https://github.com/AnomalyInnovations/serverless-stack-com/blob/master/_chapters/es/what-is-serverless.md
145143

146144
Feel free to [contact us](mailto:[email protected]) if you have any questions.
147-
148145

149-
[slack]: https://launchpass.com/serverless-stack
146+
[discord]: https://sst.dev/discord

README.md

+15-17
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@
77
<p align="center">
88
<a href="https://discourse.sst.dev"><img alt="Discourse posts" src="https://img.shields.io/discourse/https/discourse.sst.dev/posts.svg?style=for-the-badge" /></a>
99
<a href="https://twitter.com/SST_dev"><img alt="Twitter follow" src="https://img.shields.io/twitter/follow/SST_dev.svg?label=twitter&style=for-the-badge" /></a>
10-
<a href="https://sst.dev/discord"><img alt="Chat on Slack" src="https://img.shields.io/discord/983865673656705025?style=for-the-badge" /></a>
10+
<a href="https://sst.dev/discord"><img alt="Chat on Discord" src="https://img.shields.io/discord/983865673656705025?style=for-the-badge" /></a>
1111
</p>
1212

13-
------------------------------------------------------------------------------------
13+
---
1414

1515
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.
1616

@@ -20,7 +20,7 @@ We are going to create a [note taking app](https://demo.sst.dev) from scratch us
2020

2121
It is a single-page React app powered by a serverless CRUD API. We also cover how add user authentication and handle file uploads.
2222

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.
2424

2525
## Project Goals
2626

@@ -31,10 +31,10 @@ The entire guide is hosted on GitHub and we use [Discourse][Discourse] for our c
3131

3232
## Getting Help
3333

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].
3535
- 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].
3838

3939
## Source for the Demo App
4040

@@ -44,7 +44,7 @@ We also have an alternative Serverless Framework version: [backend serverless AP
4444

4545
## Contributing
4646

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].
4848

4949
## Running Locally
5050

@@ -54,36 +54,36 @@ SST is built using [Jekyll](https://jekyllrb.com). [Follow these steps to instal
5454

5555
To install, run the following in the root of the project.
5656

57-
``` bash
57+
```bash
5858
$ bundle install
5959
```
6060

6161
And to view locally.
6262

63-
``` bash
63+
```bash
6464
$ bundle exec jekyll serve
6565
```
6666

6767
You can now view the guide locally by visiting `http://localhost:4000/`.
6868

6969
You can also turn on live reloading and incremental builds while editing.
7070

71-
``` bash
71+
```bash
7272
$ bundle exec jekyll serve --incremental --livereload
7373
```
7474

7575
#### Generating the eBook
7676

7777
We use [Pandoc](https://pandoc.org) to create the eBook. You can generate it locally by following these steps.
7878

79-
``` bash
79+
```bash
8080
$ cd ~/Sites/ServerlessStackCom/etc/ebook
8181
$ make start
8282
```
8383

8484
This'll start a Docker instance. Inside the Docker run:
8585

86-
``` bash
86+
```bash
8787
$ make pdf
8888
$ make epub
8989
```
@@ -119,8 +119,6 @@ Thanks to these folks for their contributions to the content of SST.
119119

120120
This repo is maintained by [SST](https://sst.dev).
121121

122-
123-
[Slack]: https://sst.dev/slack
124-
[Discourse]: https://discourse.sst.dev
125-
[Contributing]: CONTRIBUTING.md
126-
[PR]: ../../compare
122+
[discourse]: https://discourse.sst.dev
123+
[contributing]: CONTRIBUTING.md
124+
[pr]: ../../compare

_config.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ permalink: /blog/:title:output_ext
6868
stats:
6969
newsletter: "90,000"
7070
newsletter_short: "90k"
71-
slack: "1900"
71+
discord: "2000"
7272
github: "10000"
7373
github_short: "10k"
7474

_includes/footer.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@
7474

7575
</div>
7676

77-
<p class="site-author">&copy; 2022 <a href="https://anoma.ly">Anomaly Innovations</a></p>
77+
<p class="site-author">&copy; 2023 <a href="https://anoma.ly">Anomaly Innovations</a></p>
7878

7979
</div>
8080

index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,7 @@ description: "Deploy Next.js, Remix, Astro, Solid, Vite to AWS and add any backe
272272
<p>GitHub stars</p>
273273
</li>
274274
<li>
275-
<h6>{{ site.stats.slack }}+</h6>
275+
<h6>{{ site.stats.discord }}+</h6>
276276
<p>Discord members</p>
277277
</li>
278278
<li>

0 commit comments

Comments
 (0)