diff --git a/README.md b/README.md index 631c95d1..4951c3ad 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,6 @@ Navigate into your new site’s directory and start it up. ```sh - cd gatsby-website npm install npm run develop ``` @@ -38,6 +37,8 @@ A quick look at the top-level files and directories you'll see in a Gatsby proje . ├── node_modules + ├── .github/workflows + ├── .forestry ├── content ├── src ├── static @@ -45,35 +46,37 @@ A quick look at the top-level files and directories you'll see in a Gatsby proje ├── gatsby-browser.js ├── gatsby-config.js ├── gatsby-node.js - ├── gatsby-ssr.js ├── package-lock.json └── package.json + 1. **`/node_modules`**: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed. -2. **`/content`**: This directory will contain all website's static content as which can be edited from [Forestry](https://forestry.io/). This content found in here is used to generate difference pages of the website. +2. **`/.github/workflows`**: This directory contains the source code for the workflow that builds and deploys the website to the ilymun.github.io which is a Github Pages directory. + +3. **`/.forestry`**: This directory used to contain the website layout and configuration for Forestry, which is no longer up to date nor functional, and must be migrated to TinaCMS if possible. -3. **`/src`**: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. `src` is a convention for “source code”. +4. **`/content`**: This directory will contain all website's static content as which can be edited from [Forestry](https://forestry.io/). This content found in here is used to generate difference pages of the website. -4. **`/static`**: This is where you should put any "static" files, such as css files, javascript files, and images. +5. **`/src`**: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. `src` is a convention for “source code”. -5. **`.gitignore`**: This file tells git which files it should not track / not maintain a version history for. +6. **`/static`**: This is where you should put any "static" files, such as css files, javascript files, and images. -6. **`gatsby-browser.js`**: This file is where Gatsby expects to find any usage of the [Gatsby browser APIs](https://www.gatsbyjs.org/docs/browser-apis/) (if any). These allow customization/extension of default Gatsby settings affecting the browser. +7. **`.gitignore`**: This file tells git which files it should not track / not maintain a version history for. -7. **`gatsby-config.js`**: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the [config docs](https://www.gatsbyjs.org/docs/gatsby-config/) for more detail). +8. **`gatsby-browser.js`**: This file is where Gatsby expects to find any usage of the [Gatsby browser APIs](https://www.gatsbyjs.org/docs/browser-apis/) (if any). These allow customization/extension of default Gatsby settings affecting the browser. -8. **`gatsby-node.js`**: This file is where Gatsby expects to find any usage of the [Gatsby Node APIs](https://www.gatsbyjs.org/docs/node-apis/) (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process. +9. **`gatsby-config.js`**: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the [config docs](https://www.gatsbyjs.org/docs/gatsby-config/) for more detail). -9. **`gatsby-ssr.js`**: This file is where Gatsby expects to find any usage of the [Gatsby server-side rendering APIs](https://www.gatsbyjs.org/docs/ssr-apis/) (if any). These allow customization of default Gatsby settings affecting server-side rendering. +10. **`gatsby-node.js`**: This file is where Gatsby expects to find any usage of the [Gatsby Node APIs](https://www.gatsbyjs.org/docs/node-apis/) (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process. -10. **`package-lock.json`** (See `package.json` below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. **(You won’t change this file directly).** +11. **`package-lock.json`** (See `package.json` below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. **(You won’t change this file directly).** -11. **`package.json`**: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project. +12. **`package.json`**: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project. ## 💫 Deployment -Deployment is very simple. A GitHub action is run on every commit to master. This action will build the production version of the website from the latest master and deploys the changes to [ILYMUN/ilymun.github.io](https://github.com/ILYMUN/ilymun.github.io) which are then live at [ilymun.github.io/](https://ilymun.github.io/). The pipeline takes a couple of minutes to run, so changes are only live a couple minutes after changes are commited to the repository. +Deployment is very simple. A GitHub action is run on every commit to master. This action will build the production version of the website from the latest master and deploys the changes to [ILYMUN/ilymun.github.io](https://github.com/ILYMUN/ilymun.github.io) which are then live at [ilymun.github.io/](https://ilymun.github.io/). The pipeline takes a couple of minutes to run, so changes are only live a couple minutes after changes are commited to the repository. No CI is run additionally to the Gatsby build tests. ## 🎓 Learning