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

Feature/documentation pages #105

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Conversation

anhcq151
Copy link
Collaborator

@anhcq151 anhcq151 commented Aug 8, 2021

close #16
Github pages setting should use doc-pages-uat as source branch and /root folder to build page.
My workflow is:

  • Doc writer write new doc page in asciidoc format, save into docs folder then push to branch feature/documentation-pages
  • Github action will convert all .adoc file to .html file and push to doc-pages-uat branch

@anhcq151 anhcq151 requested a review from zero88 August 8, 2021 15:36
.github/workflows/build-release-doc-pages.yml Outdated Show resolved Hide resolved
.github/workflows/build-release-doc-pages.yml Outdated Show resolved Hide resolved
@zero88
Copy link
Collaborator

zero88 commented Aug 9, 2021

@anhcq151
Copy link
Collaborator Author

@anhcq151 You can use one of these tools due to Asciidoc python is legacy:
https://docs.asciidoctor.org/maven-tools/latest/
https://asciidoctor.github.io/asciidoctor-gradle-plugin/development-3.x/user-guide/
https://docs.asciidoctor.org/asciidoctor.js/latest/ (js version)

I prefer maven or gradle.

I've updated code using mvn

Copy link
Collaborator

@zero88 zero88 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Once you finish, remove all document that you already migrated

.github/workflows/build-release-doc-pages.yml Outdated Show resolved Hide resolved
docs/pom.xml Outdated Show resolved Hide resolved
docs/pom.xml Outdated
</properties>

<build>
<plugins>
Copy link
Collaborator

@zero88 zero88 Aug 19, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use maven-site-plugin will create a typical maven document, it does not meet our brand style.

It is better if you can follow this example project to create simple HTML5 site, then add styling later (in another ticket)

Check it out and run in local to see how it works, also review its document structure.

Current structure is not good. Should split document folder as functional instead of technical name (ansible, python), also make a boundary between user guide an development document

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.

VPNC Documentation
2 participants