Commit graph

6 commits

Author SHA1 Message Date
noahtalerman
2c341ee755
Fix broken anchor links in documentation (#509)
This PR includes various fixes to anchor links used in the documentation.

There are certain characters GitHub doesn't support for the use of anchor links in markdown files. The general rule I've found is to only use a-z or A-Z characters in anchor links. All other characters should be removed.

For example, consider the section title How do I connect to the Mailhog simulated server?. The valid GitHub anchor link for this section is #how-do-i-connect-to-the-mailhog-simulated-server. Notice no ?.

Closes #494
2021-03-21 16:05:11 -07:00
Zach Wasserman
9ec122c249
Backup and restore for development database (#480)
Tooling to make backup and restore of the development database easy.
2021-03-16 08:33:42 -07:00
Zach Wasserman
fbc1636994
Improve E2E testing and test documentation (#448)
- Add Makefile commands for E2E testing.
- Document E2E testing.
- Cleanup other test documentation.
2021-03-11 15:55:58 -08:00
Zach Wasserman
20f21fafe4
Migrate tests to GitHub Actions and add E2E testing (#381)
- Migrate unit tests and linting from CircleCI to GitHub Actions
- Add E2E test in CI run
2021-03-04 17:13:28 -08:00
noahtalerman
d5f3a70152
Part 3 of documentation restructure. Contribution section. (#149)
This PR includes the Contribution section of the documentation restructure #144.
2020-12-24 14:33:03 -08:00
noahtalerman
fa6ac424ca
Part 1 of documentation restructure. Deployment section. (#147)
This PR includes the Deployment section of the documentation restructure #144.

- Changes include the addition of 3 overarching folders/sections named Deployment, Using fleet, and Contribution guide. Each folder includes new files for the subsections.
- Move the copy from the appropriate files into the new files in the Deployment folder. Removed old files. A detailed outline of the exact old files can be found in the linked issue above.
- Add navigation to the top of each file via links to anchors in the markdown.

The naming convention for each folder and file is up for discussion. I chose to use number prefixes (1, 2, 3) to order the folders and files. This way we have control over the order when viewing on GitHub.
2020-12-24 14:00:22 -08:00