Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add devsrv shell script for convenient, env-based execution of LiquiDoc #7

Open
briandominick opened this issue Apr 25, 2019 · 0 comments
Labels
enhancement New feature or request Summer2019 Priority goal for Summer 2019

Comments

@briandominick
Copy link
Contributor

I have been working on a Bash script called devsrv, which I use locally when playing with Codewriting, and now with more formal LDCMF projects. When it is truly a general-applicatin LDCMF utility, I will add it to the boilerplate (this repo) and share it with everyone. This will likely replace your commonly used bundle exec liquidoc -c _configs/build-docs.yml --etc --etc commands, first establishing default options based on the deployment environment.

Basic environments will include:

dev Running simply sh devsrv will execute a local build and Jekyll serve operation, by default running no tests.

stage This build runs tests. Use sh devsrv stage --serve-after to spin up a local instance once tests are run. Try sh devsrv stage 4001 --serve-after to spin up a local instance at port :4001 instead of default port. The stage build is probably what is run during continuous deployment ops during draft reviews.

search Pushes updated records to appropriate Algolia cloud search indices. Possibly run manually or under certain conditions by the deployment ops.

prod The final product, only to be as part of deployment ops.

The script also allows the passing of version ranges: sh devsrv 3.2-4.5, to generate just that range of docs versions.

Lots of other operations enable modifications of the standard environments.

@briandominick briandominick added enhancement New feature or request Summer2019 Priority goal for Summer 2019 labels Jun 13, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request Summer2019 Priority goal for Summer 2019
Projects
None yet
Development

No branches or pull requests

1 participant