Documentation for the liquibase website.
Please send pull requests!
Project Overview - How to apply changes to https://docs.liquibase.com
- Clone/checkout docs.liquibase.com repository
- git clone https://github.com/liquibase/liquibase-docs
- git checkout master
- git branch [newBranchName] (to create a local branch)
- git checkout [newBranchName]
- Make Desired Documentation Changes
- Make some changes to the desired html file/s or/and create new html file/s
- Open the modified html file/s on your browser to review the new changes
- Commit Your Doc Changes
- git add <file(s)> or git add . (to add all)
- git commit -m (put a meaningful message that clearly explains the changes)
- git push -u origin [newBranchName] - to create the remote branch
- Create a Pull Request
- Make a pull request to the staging branch [newBranchName] and request a review from @adrian-velonis1. You do this using the github.com website UI.
- Thank you for your submission!
- Await approval of your changes
- When approved, the staging branch will be merged to master.
- Your branch will be deleted. In this example: git checkout master && git branch -D [newBranchName] && git branch -d [newBranchName] && git push
- Your changes will be visible on https://docs.liquibase.com
The file system hierarchy in the https://github.com/liquibase/liquibase-docs repository mirrors the way they are presented in the https://docs.liquibase.com website.
For example:
- For the file residing in liquibase-docs/Content/commands/pro/rollbackonechangeset.html repository
- the corresponding url would be: https://docs.liquibase.com/commands/pro/rollbackonechangeset.html