About this knowledge base

This knowledge base is built using Gatsby and Strapi. All of the content is maintained by the CivicActions frontend engineers group.

How to contribute to this knowledge base.

🚀 Quick start

1. Clone this Gatsby site.

   git clone git@github.com:CivicActions/FE-knowledgebase.git
   

2. Start developing.

   Navigate into your new site’s directory and start it up.

   cd FE-Knowledgebase/
   npm install
   gatsby develop
   

3. Open the source code and start editing!

   Your site is now running at http://localhost:8000

   Note: You'll also see a second link: http://localhost:8000/___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.

   Open the FE-Knowledgebase directory in your code editor of choice and edit src/pages/index.js. Save your changes and the browser will update in real time!

🧐 What's this & where's the rest of it?

The FE Knowledge-base is a repository for our Front-End best practices and development tools. It can be viewed here: https://civicactions.github.io/FE-knowledgebase/

It is made up of:

1. This github repo
2. A Component Library built with PatternLab:
   • Github Repo: https://github.com/CivicActions/FE-component-library
   • Component Library: https://civicactions.github.io/FE-component-library/
3. A Static CMS built with Strapi: https://fe-knowledgebase-cms.herokuapp.com/

🏗 Development Workflow

Adding new features

1. Follow the quick start steps above to run the gatsby server.
2. Make changes and commit.
3. Create a feature branch your commits and push to the git repo. git push origin.
4. Create a PR against the master branch from the remote branch.
5. Add a description and any testing steps and tag a dev to review your PR.

Code Review

We don't have review environments yet so we need to do manual reviews in the interim.

1. When tagged to review a PR, checkout the branch locally

   git fetch origin
   git checkout -b branch-name origin/branch-name
   

2. Run npm install and gatsby develop.

3. Review the changes in http://localhost:8000

4. If things look kosher, merge the PR on github and then proceed to the Deploy section below!

💫 How to Deploy

The knowledge-base is currently hosted on Github pages and requires a manual deploy process.

1. Checkout your local master branch and pull in the latest changes.

   git checkout master
   git fetch origin
   git pull --rebase origin master
   

2. Deploy the site by running

   npm install
   npm run deploy
   

   When you run the deploy command, the gatsby site will be compiled for production and all contents of the public folder will be moved to the repository’s gh-pages branch.

😻 How to add content

Content is split into a few types, there are top level pages and recipes. There are plans to also add Projects in the future.

Top level pages are high level pages about particular frontend topics, these can contain basic descriptions and links to resources. Recipes are step by step walk throughs or tutorials on how to setup or do specific tasks.

Top level pages are built as static .mdx files. You can see these in the pages directory. These are edited and added in this repo.

Recipes are added in a separately hosted Strapi CMS. To contribute to recipes, contact any project maintainer for a content editor account.

1. Log into the CMS with your editor account: https://fe-knowledgebase-cms.herokuapp.com/
2. Create a new recipe or edit any recipe and Save.
3. Run through the deployment steps above to trigger a redeployment with the latest content updates.

Making edits to Strapi

If you need to add a field or even a whole content type to the Strapi CMS you will need to pull down a local version of the CMS from this repo: https://github.com/CivicActions/fe-knowledgebase-cms

After making your changes locally, submit a pull request to get them deployed to the CMS.