Add `devsrv` shell script for convenient, env-based execution of LiquiDoc
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- bash
- Domain
- build-system, cli
Research direction
Start by reviewing the existing bundle exec liquidoc -c _configs/build-docs.yml workflow and _configs/build-docs.yml, then define the proposed devsrv command's environment modes and arguments. The work is complete when the script supports the described dev, stage, search, and prod operations, including version ranges and --serve-after port handling.
Written by the indexing model from the issue text.
Description
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.
- Dominant language
- CSS
- Stars
- 9
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from DocOps/liquidoc-cmf
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 25/100
DocOps/liquidoc-cmf#12 ·
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 25/100
DocOps/liquidoc-cmf#11 ·
-
enhancement Summer2019
Difficulty 5/5 Over a week Newbie friendliness 20/100
DocOps/liquidoc-cmf#10 ·
-
enhancement Summer2019
Difficulty 3/5 1-2 days Newbie friendliness 35/100
DocOps/liquidoc-cmf#9 · 1 reaction ·
-
enhancement Summer2019
Difficulty 5/5 Over a week Newbie friendliness 20/100
DocOps/liquidoc-cmf#8 ·
All issues in DocOps/liquidoc-cmf
Similar issues
-
0.kind: build failure
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
category:port-update
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
Maintainers usually reply within 2 days
-
dev/release: verify-release-candidate.sh runs 0 Java tests with Debian's MavenPossibly taken @kou claimed this today. OpenType: bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
apache/arrow-adbc#4947 ·
Maintainers usually reply within 1 day
-
MinGW build faillureOpen
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
facebookresearch/faiss#5775 · 1 comment ·
Maintainers usually reply within 2 days
-
bug priority: high
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
snapotter-hq/SnapOtter#3863 · 2 comments ·
Maintainers usually reply within 1 day