Quantcast
Channel: Liquibase Forums
Viewing all articles
Browse latest Browse all 2993

Steps contributing the documentation

$
0
0
Hi,

I'm trying to contribute in the documentation also. If I understand correctly to change the documentation of a change like loadData then the steps are:
  1. Clone the liquibase repository
  2. Change the description value of the DatabaseChange or DatabaseChangeProperty annotation in the liquibase-core folder of the liquibase repository
  3. Build the liquibase.jar and copy it into the _doc_generators folder of the liquibase.github.com repository clone
  4. Change the pom.xml to use the local copy
  5. build the docGenerator `mvn package`
  6. in the root of the  liquibase.github.com repository run `java -jar liquibase-docgenerator-1.0.0.local-SNAPSHOT.jar`
    It updates the documentation/changes/*.md files from the compiled classes' DatabaseChange and DatabaseChangeProperty annotations
  • Are steps 3-6 needed or some CI step does it?
    • If not then what shall be the next step(s)?
    • Shall the updated documentation/changes/*.md files committed and PR created against the staging branch of the liquibase.github.com repository?
    • Or the *.htmls shall be also generated further from the *.md files some way and committed?
    • Or it is done by some CI step? If not, shall the bundle used for that?
What are the steps for other changes like changing documentation\changeset.md?

Thanks,
    Gyula Bibernáth

Viewing all articles
Browse latest Browse all 2993

Trending Articles



<script src="https://jsc.adskeeper.com/r/s/rssing.com.1596347.js" async> </script>