Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move Brim docs to a GitHub wiki #657

Closed
philrz opened this issue Apr 21, 2020 · 1 comment · Fixed by #659, #660, #663 or #664
Closed

Move Brim docs to a GitHub wiki #657

philrz opened this issue Apr 21, 2020 · 1 comment · Fixed by #659, #660, #663 or #664
Assignees

Comments

@philrz
Copy link
Contributor

philrz commented Apr 21, 2020

We've gotten into the habit of creating markdown docs in the repos next to the code. While some of these are commonly handled this way (README, CONTRIBUTING, CHANGELOG, and code_of_conduct), there's others that should likely move to a wiki (TROUBLESHOOTING, README-Windows). That wiki can surely be populated with more articles over time.

At some point we'll want to sync certain docs from the zq repo to the wiki as well (e.g. the ZQL docs) since Brim depends on these. However, as a first step we'll just get the wiki up & running with what's already in the Brim repo.

@philrz
Copy link
Contributor Author

philrz commented Apr 24, 2020

The wiki is now alive at https://github.com/brimsec/brim/wiki, with GitHub Actions that ensure it's always kept up to date with any content in the docs/ directory that's merged to master.

image.png

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment