Skip to content

Commit

Permalink
improving docs
Browse files Browse the repository at this point in the history
  • Loading branch information
acivitillo committed Feb 14, 2025
1 parent 6dc5603 commit d311bdc
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,17 @@ Blog articles are markdown files inside the `src/posts` folder. The top of the m

**images** should be stored in `src/images`.


### Editor Workflow

* Use `/admin` to do all changes of content to the `dev` branch using the Sveltia UI
* After changes are done to `dev`, notify the site admins that changes should be pushed to production site
* The admins will make a PR in Github from `dev` to `main` and changes will automatically be deployed to the production site within 2-3 mins (Netlify is doing the deployment)

### Adding new Pages / Templates

* Create a github issue with `webdeveloper` tag, web developer will do this

### Running the Site Locally

This site is using a static page generator called `eleventy`, you can read its documentation [here](https://www.11ty.dev/).
Expand All @@ -22,6 +33,16 @@ cd site-thescalableway
npm run start
```

### Deployed Sites

- Production is deployed from `main` branch and is available here https://thescalableway.com/
- Dev is deployed from `dev` branch and is available here https://dev--thescalableway.netlify.app/


### Admin Panel

Admin panel is deployed using Sveltia CMS. All admin configurations are in `src/admin/config.yml`.

### Theme Support

For support see: [eleventy-excellent](https://github.com/madrilene/eleventy-excellent).

0 comments on commit d311bdc

Please sign in to comment.