https://github.com/thingsym/vaw-documentation
VAW (Vagrant Ansible WordPress) technical documentation for developer
https://github.com/thingsym/vaw-documentation
documentation
Last synced: 3 months ago
JSON representation
VAW (Vagrant Ansible WordPress) technical documentation for developer
- Host: GitHub
- URL: https://github.com/thingsym/vaw-documentation
- Owner: thingsym
- License: gpl-2.0
- Created: 2017-12-06T05:35:12.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-08-19T09:12:20.000Z (over 1 year ago)
- Last Synced: 2024-12-29T22:40:48.105Z (over 1 year ago)
- Topics: documentation
- Language: Shell
- Homepage: https://thingsym.github.io/vaw/
- Size: 3.63 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# VAW (Vagrant Ansible WordPress) Documentation
## Docker environment
### Server
```
cd /path/to/vaw-documentation
docker-compose up -d
```
Browse site on http://localhost:1313/vaw/
### Generate documentation
```
docker-compose run --rm hugo -d public --minify
```
## Local development environment
### Install Hugo
```
cd /path/to/vaw-documentation
sudo bash bin/installer-hugo.sh
hugo help
```
### Start server
```
hugo server --bind 0.0.0.0 -wD --ignoreCache --minify
```
Browse site on http://localhost:1313/vaw/
### Generate documentation
```
hugo -d public --minify
```
## Contribution
### Patches and Bug Fixes
Small patches and bug reports can be submitted a issue tracker in Github. Forking on Github is another good way. You can send a pull request.
1. Fork [VAW Documentation](https://github.com/thingsym/vaw-documentation) from GitHub repository
2. Create a feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Create new Pull Request
## License
distributed under [GPLv3](https://www.gnu.org/licenses/gpl-3.0.html).