Skip to content

docs(site redesign): Overhaul Docs Site#5731

Merged
maggiehays merged 8 commits intodatahub-project:masterfrom
maggiehays:docs-redesign-fork
Aug 26, 2022
Merged

docs(site redesign): Overhaul Docs Site#5731
maggiehays merged 8 commits intodatahub-project:masterfrom
maggiehays:docs-redesign-fork

Conversation

@maggiehays
Copy link
Copy Markdown
Collaborator

@maggiehays maggiehays commented Aug 25, 2022

There's a lot packed in this PR; here are the main changes:

New landing page for datahubproject.io

CleanShot 2022-08-22 at 16 02 29

New landing page for datahubproject.io/docs

CleanShot 2022-08-22 at 16 02 40

New sidebar organization

CleanShot 2022-08-22 at 16 02 57

Compiling open-source and managed DataHub docs in a single place

  • Sidebar will show "cloud" icon on Managed-DataHub-only resources
  • New page template to call out features that are Managed-DataHub-only vs. available in OSS
    CleanShot 2022-08-22 at 16 03 04

The following is out of scope for this PR & will be addressed in fast-follow work:

  • add consistency to "tutorial" vs. "usage guide" vs. "feature guide" naming conventions
  • migrate existing Managed DataHub docs to the unified docs site
  • write up all 31 feature guide/usage guide docs in the /docs/wip/ directory
    • once complete, migrate them to main docs directory
  • create missing guides:
    • Entity health check status
    • Column level lineage
    • Groups
    • Entity usage statistics & Profiling

Checklist

  • The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
  • Links to related issues (if applicable)
  • Tests for the changes have been added/updated (if applicable)
  • Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
  • For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Aug 26, 2022

Unit Test Results (build & test)

504 tests  ±0   504 ✔️ ±0   9m 30s ⏱️ +15s
117 suites ±0       0 💤 ±0 
117 files   ±0       0 ±0 

Results for commit bc0c503. ± Comparison against base commit e448bb8.

♻️ This comment has been updated with latest results.

@maggiehays maggiehays marked this pull request as ready for review August 26, 2022 16:04
@maggiehays maggiehays merged commit 59f8c9b into datahub-project:master Aug 26, 2022
@maggiehays maggiehays deleted the docs-redesign-fork branch August 29, 2022 17:47
asikowitz added a commit that referenced this pull request Jul 3, 2025
Co-authored-by: Andrew Sikowitz <andrew.sikowitz@acryl.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants