lmccay opened a new pull request, #1040:
URL: https://github.com/apache/knox/pull/1040

   (It is very **important** that you created an Apache Knox JIRA for this 
change and that the PR title/commit message includes the Apache Knox JIRA ID!)
   
   ## What changes were proposed in this pull request?
   
   Let's address the cumbersome documentation site by moving to MkDocs as was 
mentioned on the dev@ list.
   
   This Jira will represent the initial task of creating a PR within the Knox 
repo for a feature branch that we can iterate on and replace our existing docs 
mechanism within the Apache Site svn with docs generated by MkDocs and 
published to gitpages. This will be more standard and easier to contribute to 
going forward.
   
   I don't want to wait until it is perfect in my repo before moving it over 
since it will take too long and I will likely move on to other things. This 
will allow us to have a bit of a Docathon to fix formatting and other issues 
with the current state of my fork.
   ## How was this patch tested?
   
   (Please explain how this patch was tested. For instance: running automated 
unit/integration tests, manual tests. Please write down your test steps as 
detailed as possible)
   
   Built and published to my fork's git pages: https://lmccay.github.io/knox/
   
   We will need to iterate on this to get it done.
   
   Please review [Knox Contributing 
Process](https://cwiki.apache.org/confluence/display/KNOX/Contribution+Process#ContributionProcess-GithubWorkflow)
 before opening a pull request.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscr...@knox.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

Reply via email to