Git Product home page Git Product logo

liquibase-docs's Introduction

docs.liquibase.com

Documentation for the liquibase website.

The files in the scripts\redirect_creation directory comprise the terraform configuration called by our GitHub Actions workflows for the publishing of 301 redirects to documentation websites, both staging and production.

The publishing of site redirects is part of the overall content publishing workflow used by the Liquibase Documentation Team.

Please send us pull requests if you see something that needs to be updated!

How to make docs changes

This workflow is as follows:

  1. Documentation team members publish updated content to a staging site directly from their content management system (Flare).
  2. They then create a Pull Request (PR) from a new branch to the master branch or sometimes make commits directly to master branch that adds or updates 301 redirects in the repo/scripts/redirect_creation/variables.tf file.
  3. The creation of the PR runs send-docs-redirects-to-staging.yml first and then after it's completion runs send-enterprise-redirects-to-staging.yml, which automatically runs the Terraform plan and outputs changes to be applied in the s3://stage-docsstageliquibasecom-origin and s3://stage-enterprisestagedocsliquibasecom-origin respectively to their stagging bucket.
  4. The Docs team merges the PR into master or changes directly made to master : runs send-docs-redirects-to-staging.yml and then runs send-enterprise-redirects-to-staging.yml which automatically stages redirect changes to s3://stage-docsstageliquibasecom-origin and s3://stage-enterprisestagedocsliquibasecom-origin respectively (in liquibase-admin) for preview.
  5. The Docs team then previews/verifies both content and redirects on the staging site.
  6. At this point the public documentation website for Liquibase should be fully up to date.

Thank you for your submission!

liquibase-docs's People

Contributors

adrian-velonis1 avatar nmelny avatar ambermw13 avatar cmmay avatar jandroav avatar mccormickc avatar ap-liquibase avatar szandany avatar molivasdat avatar nvoxland avatar jnewton03 avatar sayalim0412 avatar ro-rah avatar bbrown-at-datical avatar mcred avatar fburguer avatar ldeck avatar r2-lf avatar kevin-atx avatar kataggart avatar brainsucker avatar kevin-chappell avatar luankevinferreira avatar marcelstoer avatar boiarshinov avatar dependabot[bot] avatar melienherrera avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.