Commit graph

20 commits

Author SHA1 Message Date
Zach Wasserman
7f43472431
Improve build documentation (#513)
Clarifies documentation based on observations from #510 and testing.
2021-03-22 13:34:34 -07:00
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
James Alseth
1da89ea987
Publish Helm chart (#475)
This adds a GH Action to publish the updated Helm chart with each new release. It can also be triggered manually if needed.

Fixes #345
2021-03-17 11:09:01 -07:00
noahtalerman
7970fa46a4
Add note to update the #fleet channel's topic in Releasing Fleet documentation (#482) 2021-03-16 17:30:02 -04: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
Mike Thomas
8713daf44f
Update 1-Building-Fleet.md (#314)
Add correct Docker link to Building Fleet doc.
2021-02-15 11:22:43 -08:00
Mike Thomas
7bfce469de
Update 1-Building-Fleet.md (#313)
Added text to clarify that a new terminal tab should be opened after making changes to bash profile.
2021-02-15 11:21:57 -08:00
Zach Wasserman
e2e7e4707d
Update database migration tooling (#281)
- Use updated github.com/fleetdm/goose that generates templates
  requiring less editing.
- Add `make migration` to Makefile.
- Update documentation.
2021-02-05 09:48:06 -08:00
Zach Wasserman
78c3b120e2
Add documentation for committing changes (#278)
Replaces documentation on ADRs which are not currently used.
2021-02-05 09:47:32 -08:00
Zach Wasserman
ffd99ae9b7
Update release instructions (#275) 2021-02-04 09:09:39 -08:00
Zach Wasserman
8fcd14b394
Add --dev flag and change docker defaults (#251)
- Add --dev flag that will set default flag values. This simplifies the
  invocation of Fleet in a development environment.
- Change defaults in docker-compose to use `fleet` in place of `kolide`.
-  Skip prompt in `prepare db` when `--dev` specified.
- Update developer documentation.

Updates to MySQL configuration in docker-compose.yml may require
existing development containers and volumes to be deleted (this will
delete data in MySQL):

```shell
docker-compose rm -sf
docker volume rm fleet_mysql-persistent-volume
```

Closes #170
2021-02-01 18:14:16 -08:00
Gabe Hernandez
5816f4f051
Update build-fleet.md with chrome bug note and new link (#256) 2021-02-01 16:27:00 +00:00
noahtalerman
6196859bc5
Add allow insecure local host flag instructions to contributor docs. (#179)
In contributor docs, mention chrome://flags/#allow-insecure-localhost.
2021-01-07 12:04:41 -08:00
noahtalerman
715d7b44e2
Fix markdown link check CI action. (#169)
- Split the array of objects to separate objects for each pattern in ignorePatterns. Rename the key in each object to "pattern." The documentation for the example config file is poor.
- Add hello@fleetdm.com and /server/datastore/mysql/migrations/ to ignorePatterns
- Add 999 to aliveStatucCodes (Seems to be a LinkedIn edge case)
- Fix all broken markdown links
2021-01-04 13:55:05 -08:00
noahtalerman
72637d649b
Update links to new documentation locations. (#164)
- Add correct links to the new docs locations for links within the Fleet UI and Fleet documentation.
Fixes #157.
2021-01-04 08:53:23 -08:00
Zach Wasserman
6a3c511eca
Update developer docs (#159)
- Separate migration documentation from build.
- Add link to server on localhost after setup.
2020-12-30 15:20:02 -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