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

fix: Revamp features page #8839

Merged
merged 17 commits into from Nov 22, 2023
Merged

fix: Revamp features page #8839

merged 17 commits into from Nov 22, 2023

Conversation

yoonhyejin
Copy link
Collaborator

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 github-actions bot added the docs Issues and Improvements to docs label Sep 14, 2023
@yoonhyejin yoonhyejin marked this pull request as ready for review November 20, 2023 07:00
@yoonhyejin yoonhyejin changed the title fix: test out features page fix: Revamp features page Nov 20, 2023
hsheth2
hsheth2 reviewed Nov 20, 2023
View reviewed changes
Copy link
Collaborator

@hsheth2 hsheth2 left a comment

Choose a reason for hiding this comment

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

some minor style things, but overall looking good

one thing I want to talk about: people like screenshots. while I agree that this page isn't the right place for screenshots, what do you think is the right place for them?

docs-website/src/pages/docs/_components/QuickstartCards/index.jsx Outdated Show resolved Hide resolved
docs-website/src/pages/docs/_components/FeatureCardSection/index.jsx Show resolved Hide resolved
docs-website/src/pages/docs/_components/FeatureCardSection/index.jsx Show resolved Hide resolved
docs/features.md Outdated Show resolved Hide resolved
@yoonhyejin
Copy link
Collaborator Author

@hsheth2 thx for the feedback! made some changes, let me know your thoughts

hsheth2
hsheth2 approved these changes Nov 22, 2023
View reviewed changes
Copy link
Collaborator

@hsheth2 hsheth2 left a comment

Choose a reason for hiding this comment

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

mostly looking good, nits on two small details

docs-website/src/pages/docs/_components/FeatureCardSection/featurecardsection.module.scss Show resolved Hide resolved
docs-website/src/pages/docs/_components/QuickstartCards/index.jsx Outdated
{
title: "Quickstart with DataHub",
icon: "datahub-logo-color-mark",
to: "docs/quickstart",
Copy link
Collaborator

Choose a reason for hiding this comment

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

it seems like these links doesn't respect the currently active version

there might be some weird docusaurus magic required here to prefix the links (https://docusaurus.io/docs/docusaurus-core#useDocusaurusContext). alternatively, it might work if you make them relative links e.g ./quickstart or something

@yoonhyejin yoonhyejin enabled auto-merge (squash) November 22, 2023 09:57
@yoonhyejin yoonhyejin merged commit fd129c7 into master Nov 22, 2023
32 of 33 checks passed
@yoonhyejin yoonhyejin deleted the docs/features-refactor branch November 22, 2023 10:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hsheth2 hsheth2 hsheth2 approved these changes

@maggiehays maggiehays Awaiting requested review from maggiehays

Assignees
No one assigned
Labels
docs Issues and Improvements to docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@yoonhyejin @hsheth2