-
Notifications
You must be signed in to change notification settings - Fork 78
Back to Milestones
Documentation (wiki) restructuring
OpenFeb 7, 2024
No due date
•Last updated Make it easier to navigate and find important information.
Problems identified:
- Documentation is not structured well to be intuitive: scattered, repetitive.
- difficult to navigate and difficult to find what you need.
- Documentation and different (use) cases are found difficult
Goals
- Restructuring of documentation, in the Wiki. A new way of structuring the wiki must be created, agreed upon, and implemented.
- No new documentation needs to be written as part of this issue. Only existing documentation refactoring is required. That may including moving, deleting, splitting up pages or combining pages as deemed necessary
Included in VDK Initiative(s): #2426
36% complete
List view
0 of 7 selected 0 issues of 7 selected
Documentation testing: Research and come up with a documentation testing process
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requeststoryTask for an EpicTask for an EpicStatus: Open.#2395 In vmware/versatile-data-kit;Move user-relevant READMEs to the User Wiki
documentationImprovements or additions to documentationImprovements or additions to documentationstoryTask for an EpicTask for an EpicStatus: Open.#2148 In vmware/versatile-data-kit;Wiki: Implement testing feedback to Wiki page
documentationImprovements or additions to documentationImprovements or additions to documentationStatus: Open.#2892 In vmware/versatile-data-kit;Wiki: Create a page for Templates
documentationImprovements or additions to documentationImprovements or additions to documentationStatus: Open.#3079 In vmware/versatile-data-kit;Wiki: Create a page for Deployment
documentationImprovements or additions to documentationImprovements or additions to documentationStatus: Open.#3080 In vmware/versatile-data-kit;Wiki: Create a page for Production
documentationImprovements or additions to documentationImprovements or additions to documentationStatus: Open.#3081 In vmware/versatile-data-kit;Wiki: Create 3 pages for UI - Overview, Installation and Getting Started
documentationImprovements or additions to documentationImprovements or additions to documentationStatus: Open.#3082 In vmware/versatile-data-kit;