Skip to content

Use asciidoc for the doc to remain readable#36

Open
chevdor wants to merge 7 commits intomasterfrom
wk-230228-improve-doc
Open

Use asciidoc for the doc to remain readable#36
chevdor wants to merge 7 commits intomasterfrom
wk-230228-improve-doc

Conversation

@chevdor
Copy link
Contributor

@chevdor chevdor commented Feb 28, 2023

Using markdown to build a toc for instance is rather heavy and makes the md no longer so readble...
Asciidoc allows for better doc and this is what this PR introduces.

The PR contains also an attempt for a new just script to install all the tools required by the GH Workflows but considering the amount to install on the user's system, I preferred to remove some of the just recipes to prevent the user from thinking it is trivial to run those.

@chevdor chevdor requested a review from a team as a code owner February 28, 2023 14:50
@chevdor
Copy link
Contributor Author

chevdor commented Feb 28, 2023

The linter issue (which is actually not an issue...) is resolved by #35

@chevdor
Copy link
Contributor Author

chevdor commented Feb 28, 2023

NOTE: the Dockerfile will need a fix to be confirmed.

RUN apt-get update && apt-get install -yq --no-install-recommends ca-certificates bash jq unzip curl && \
	curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "/tmp/awscliv2.zip" && \
	unzip "/tmp/awscliv2.zip" && rm "/tmp/awscliv2.zip" && \
	/aws/install && rm -rf /aws && \
	apt -yq remove ca-certificates unzip && apt -yq autoremove && \
	aws --version

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants