-
Notifications
You must be signed in to change notification settings - Fork 0
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
base: main
Are you sure you want to change the base?
Conversation
@anhcq151 You can use one of these tools due to Asciidoc python is legacy: I prefer |
I've updated code using |
There was a problem hiding this 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
docs/pom.xml
Outdated
</properties> | ||
|
||
<build> | ||
<plugins> |
There was a problem hiding this comment.
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
close #16
Github pages setting should use
doc-pages-uat
as source branch and/root
folder to build page.My workflow is:
asciidoc
format, save intodocs
folder then push to branchfeature/documentation-pages
.adoc
file to.html
file and push todoc-pages-uat
branch