[
https://issues.apache.org/jira/browse/KNOX-3144?focusedWorklogId=968438&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-968438
]
ASF GitHub Bot logged work on KNOX-3144:
----------------------------------------
Author: ASF GitHub Bot
Created on: 03/May/25 15:02
Start Date: 03/May/25 15:02
Worklog Time Spent: 10m
Work Description: lmccay opened a new pull request, #1037:
URL: https://github.com/apache/knox/pull/1037
(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?
Move doc site to MkDocs based site maintained within the Knox project repo -
separate from the Apache Knox project website. We will publish docs to gitpages
for the project and point the site there.
## How was this patch tested?
Locally generated and tested and published to the gitpages for my fork.
Please review [Knox Contributing
Process](https://cwiki.apache.org/confluence/display/KNOX/Contribution+Process#ContributionProcess-GithubWorkflow)
before opening a pull request.
Issue Time Tracking
-------------------
Worklog Id: (was: 968438)
Remaining Estimate: 0h
Time Spent: 10m
> Move Documentation Site into the Source Tree
> --------------------------------------------
>
> Key: KNOX-3144
> URL: https://issues.apache.org/jira/browse/KNOX-3144
> Project: Apache Knox
> Issue Type: Improvement
> Components: Document
> Reporter: Larry McCay
> Assignee: Larry McCay
> Priority: Major
> Fix For: 2.2.0
>
> Time Spent: 10m
> Remaining Estimate: 0h
>
> 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.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)