[HOP-2643] Make our documentation feature-complete

• Type: Task
• Status: Resolved
• Priority: Blocker
• Resolution: Fixed
• Fix Version/s: 1.0.0
• Component/s: Documentation
• Labels: pull-request-available
• Assignee: Hans Van Akelyen
• Reporter: Matt Casters
• Created: 23/Mar/21 08:21
• Updated: 13/Sep/21 18:05
• Resolved: 13/Sep/21 13:52

Description

Feature-complete: cover all functional areas.

Please create sub-tasks for specific documentation deficits.

Issue Links

• incorporates: HOP-2742 document file explorer perspective
• incorporates: HOP-2743 document file dialog/chooser
• incorporates: HOP-2766 document partitioning
• incorporates: HOP-2774 rework Hop Gui main page
• incorporates: HOP-2813 document pipeline unit testing
• incorporates: HOP-2818 extend Neo4j technology documentation
• incorporates: HOP-2768 extend Hop Web documentation
• incorporates: HOP-2773 add guidance to the user manual root page
• incorporates: HOP-2817 cleanup transform adoc file names and nav.adoc
• is a parent of: HOP-2670 update getting started guide
• is a parent of: HOP-2737 replace hop-uit with hop import documentation
• is a parent of: HOP-2738 extend plugins documentation
• is a parent of: HOP-3267 add frontmatter description to documentation pages
• is a parent of: HOP-3090 Add doc to Beam Bigtable Input/Output
• is a parent of: HOP-3211 Document beam-bigtable-input and beam-bigtable-output
• links to: GitHub Pull Request #64
• links to: GitHub Pull Request #914

Sub-Tasks

• Document Hop user best practices: Resolved
• hop-conf - add info how to remove env vars or system props: Resolved
• document file access over VFS: Resolved
• document salesforce transforms: Resolved
• Document the new VFS plugins: Resolved
• document Hop server rest api: Resolved
• create usage documentation + examples for the various runtime configurations: Resolved
• Create documentation for Token Replacement plugin: Resolved
• Document project metadata: Resolved
• Document project advanced configuration: Resolved
• Document metadata injection: Resolved
• Document metadata types: Resolved
• Document password handling: Resolved
• Document plugins: improve: Resolved
• Document samples: Resolved
• Document Azure technology plugin: Resolved
• Document Cassandra technology plugin: Resolved
• Document the Hop Conf script: Resolved
• document file explorer perspective: Resolved
• document file dialog/chooser: Resolved
• document partitioning: Resolved
• rework Hop Gui main page: Resolved
• Document Mappings: Resolved
• Migrate Documentation to code repository: Resolved
• Add ASF headers to doc files: Resolved
• cleanup docs from plugins in code repository: Resolved
• document pipeline unit testing: Resolved
• extend Neo4j technology documentation: Resolved
• document Azure technology plugin: Resolved
• document missing Neo4j transforms: Resolved
• document Hop architecture: Resolved
• document transform and general error handling: Resolved