Skip to content

Update README.md #415

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #415

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 13 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,26 @@ This repository is responsible for most content visible on the website [techwork

Open a browser to localhost:8080

## Join
* When users fill out the [/subscribe]([url](https://techworkerscoalition.org/subscribe/)) form, they are invited to check out our [community guidelines]([url](https://techworkerscoalition.org/community-guide/))
* After submitting the form, they are redirected to [/welcome]([url](https://techworkerscoalition.org/welcome) which explains next steps.
* Under the hood, the website uses "Netlify form" and if it's not spam, will trigger Zapier integration requests to ActionNetwork (newsletter subscription), Slack (for manual verification)

## DecapCMS

In addition to GitHub, you can update the website via [DecapCMS](https://decapcms.org/) for example adding new blog posts and events by going to [/admin](https://techworkerscoalition.org/admin) interface. For local development, visit this [tutorial](https://decapcms.org/docs/working-with-a-local-git-repository/) (run `npx decap-server` from a different shell)
In addition to GitHub, you can update the website via [DecapCMS](https://decapcms.org/) for example adding new blog posts and events by going to [/admin](https://techworkerscoalition.org/admin) interface.
* The [/admin](https://techworkerscoalition.org/admin) interface allows anyone with a Gmail or GitHub account to create/edit existing event and blog posts.
* Future improvements can include navigation links and static pages, for example the [Merchandise page]([url](https://techworkerscoalition.org/merch/))
* Feedback on making the DecapCMS more intuitive and friendly is always welcome. Create a GitHub issue, contact [email protected] or ping us in our Slack channel #twc-infrastructure
* For local development, visit this [tutorial](https://decapcms.org/docs/working-with-a-local-git-repository/) (run `npx decap-server` from a different shell)

## Add your city

If your country/city's TWC chapter is not mentioned in the website, link to it on the homepage [here](_layouts/home.html) and if you want a local markdown page (as opposed to external link) see the other examples [here](city_local).
If your TWC chapter is not mentioned in the website, update the [chapter page](_data/chapters.yaml). Internal files can also be stored in [chapter_local folder](chapter_local)

## Add a press mention

Inside [`_data/press.yml`](_data/press.yml) file, add a media entry, with date format in `YYYY-MM-DD`
* TWC mentioned in the media or update? Create a media entry, with date format in `YYYY-MM-DD`
* Update entry in [`_data/press.yml`](_data/press.yml)

## Translation

Expand All @@ -39,9 +48,6 @@ Note, only the default [en.yml](_i18n/en.yml) must contain the names of each lan

To include only certain languages, specify the exact language keys you want inside the page front matter. For example `languages: ["en", 'ja']`

### Supported Pages
* Landing Page [index.md](index.md)
* Community Guide [_i18n/en/guide.md](_i18n/en/guide.md) and [guide.md](guide.md)

### Supported Languages
* English
Expand Down