Skip to content

Latest commit

 

History

History
37 lines (30 loc) · 2.01 KB

CONTRIBUTING.md

File metadata and controls

37 lines (30 loc) · 2.01 KB
Raw

docs.liquibase.com

Documentation for the liquibase website.

Please send pull requests!

Project Overview - How to apply changes to https://docs.liquibase.com

  1. Clone/checkout docs.liquibase.com repository
    1. git clone https://github.com/liquibase/liquibase-docs
    2. git checkout master
    3. git branch [newBranchName] (to create a local branch)
    4. git checkout [newBranchName]
  2. Make Desired Documentation Changes
    1. Make some changes to the desired html file/s or/and create new html file/s
    2. Open the modified html file/s on your browser to review the new changes
  3. Commit Your Doc Changes
    1. git add <file(s)> or git add . (to add all)
    2. git commit -m (put a meaningful message that clearly explains the changes)
    3. git push -u origin [newBranchName] - to create the remote branch
  4. Create a Pull Request
    1. 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.
    2. Thank you for your submission!
  5. Await approval of your changes
    1. When approved, the staging branch will be merged to master.
    2. Your branch will be deleted. In this example: git checkout master && git branch -D [newBranchName] && git branch -d [newBranchName] && git push
    3. Your changes will be visible on https://docs.liquibase.com

Where and how to find and modify the required html file from the url

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: