Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: hosted documentation website #2174

Merged
merged 48 commits into from
Mar 5, 2021
Merged

docs: hosted documentation website #2174

merged 48 commits into from
Mar 5, 2021

Conversation

hsheth2
Copy link
Collaborator

@hsheth2 hsheth2 commented Mar 5, 2021 •
edited
Loading

  • Clean up docs throughout the repo (fix typos, fix broken links, prefer relative links, use headings properly, etc)
  • Create a website for hosting those docs using Docusaurus v2
  • Add a landing page for DataHub

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)

hsheth2 added 30 commits March 4, 2021 23:28
@hsheth2
fix some html escapes
6201f64
@hsheth2
Run npx @docusaurus/init@latest init docs-website classic
1926d8f
@hsheth2
shuffle default docs
5628814
@hsheth2
auto extract titles
0acd907
@hsheth2
Rewrite links
300d324
@hsheth2
write out generated docs
203a345
@hsheth2
fix doc pages
49b5591
@hsheth2
most of sidebar
2f86f52
@hsheth2
fix table rendering
e86d53c
@hsheth2
remove readme text from urls
08041d4
@hsheth2
reorg sidebar
6d2bfa9
@hsheth2
start updating docs
b24a91a
@hsheth2
start renaming files
a92f5a1
@hsheth2
use only one h1 header
173d0b9
@hsheth2
start adding branding
877a926
@hsheth2
setup footer
089b9c8
@hsheth2
Remove spaces from pdf names
dd61252
@hsheth2
add search
a3b93fe
@hsheth2
add yarn scripts
46080f7
@hsheth2
test custom css
c689208
@hsheth2
Fix edit urls
523fee4
@hsheth2
add k8s docs
5e26862
@hsheth2
update theme
5ef2d15
@hsheth2
back to blue
fa06a94
@hsheth2
datahub blue theme
7dd3459
@hsheth2
add features
46b4400
@hsheth2
add logos
cbe8850
@hsheth2
add metadata ingestion to readme
ba6f957
@hsheth2
add discovery section
975c1a7
@hsheth2
add dataset context item
d59821c
shirshanka
shirshanka approved these changes Mar 5, 2021
View reviewed changes
Copy link
Contributor

@shirshanka shirshanka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great overall.

@shirshanka shirshanka merged commit 20bf794 into datahub-project:master Mar 5, 2021
@hsheth2 hsheth2 deleted the docs branch December 8, 2021 06:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shirshanka shirshanka shirshanka approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@hsheth2 @shirshanka