https://github.com/vsoch/askci

version controlled knowledge base for documentation and support
https://github.com/vsoch/askci

askci django documentation q-and-a support

Last synced: about 1 month ago
JSON representation

version controlled knowledge base for documentation and support

• Host: GitHub
• URL: https://github.com/vsoch/askci
• Owner: vsoch
• License: mpl-2.0
• Created: 2019-11-24T01:46:55.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-03-21T22:32:07.000Z (almost 2 years ago)
• Last Synced: 2025-01-06T03:05:36.450Z (about 1 month ago)
• Topics: askci, django, documentation, q-and-a, support
• Language: Python
• Homepage: https://vsoch.github.io/askci
• Size: 9.45 MB
• Stars: 9
• Watchers: 4
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# AskCI

![https://vsoch.github.io/askci/docs/getting-started/img/home.png](https://vsoch.github.io/askci/docs/getting-started/img/home.png)

See the [documentation](https://vsoch.github.io/askci/) for getting started.

## Background

I invisioned creating a shared documentation server back in 2017, something I called "The Documentation Octopus" since it would span multiple universities. I started to work on a [server](https://www.github.com/researchapps/helpme-server) that users could submit help requests to,

but realized that a much more extendable tool would be to provide a client that can submit

help requests to already existing servers. That project turned into [helpme](https://www.github.com/vsoch/helpme) and the server was largely abandoned. I joined the [AskCI](https://ask.ci) community at the end of 2018, and while we use a Discourse installation, it still feels like many elements are missing. Since I can make some time, I figured I'd give this another Go.

## Images Included

AskCI consists of several Docker images, and they are integrated 

to work together using [docker-compose.yml](docker-compose.yml). 

The images are the following:

 - **vanessa/askci**: is the main uwsgi application, which serves a Django (python-based) application.

 - **nginx**: pronounced (engine-X) is the webserver. The starter application is configured for http, however you should follow the instructions to set up https properly. Note that we build a custom nginx image that takes advantage of the [nginx upload module](https://www.nginx.com/resources/wiki/modules/upload/).

 - **worker**: is the same uwsgi image, but with a running command that is specialized to perform tasks. The tasks are run via [django-rq](https://github.com/rq/django-rq) that uses a

 - **redis**: database to organize the jobs themselves.

 - **scheduler** jobs can be scheduled using the scheduler.

## Thank Yous

 - [tui.editor](https://github.com/nhn/tui.editor) offers a beautiful editor for markdown.

## License

This project is under the MIT License. See the [LICENSE](LICENSE) file for the full license text. See [LICENSE-djacket](.github/LICENSE-djacket) for the upstream license.