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.

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

docs(getting started) Update Getting Started landing page #6282

Merged

Conversation

maggiehays
Copy link
Collaborator

@maggiehays maggiehays commented Oct 25, 2022

This PR contains the following:

  • Update to existing "Get Started" landing page to provide high-level overview of the section
  • Update quicklinks

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 Oct 25, 2022
* Deploy DataHub on your local machine
* Ingest sample data to get a feel for what is possible in DataHub
* Add and invite users to DataHub
* Troubleshoot common issues
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

We'll need to update this list as the scope of the section expands

Copy link
Contributor

Choose a reason for hiding this comment

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

Good point!


* Add and invite users to DataHub
* Configure Slack notifications
* Understand Approval Workflows
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Same as above -- We'll need to update this list as the scope of the section expands

Copy link
Contributor

Choose a reason for hiding this comment

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

Should we add set up SSO here?

Copy link
Contributor

Choose a reason for hiding this comment

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

As an alternative to add and invite users

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@aditya-radhakrishnan we haven't migrated SaaS-specific SSO configuration docs yet, so I'm a little hesitant to add it in until we do

Copy link
Contributor

Choose a reason for hiding this comment

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

Makes sense!

<p>
<a
className='button button--primary button--lg'
href="authentication/guides/add-users">
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This hyperlinks out to the first article in the Managed DataHub section; we'll need to update the link if we change the ordering of articles in the sidebar.

<p>
<a
className='button button--primary button--lg'
href="quickstart">
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This hyperlinks out to the first article in the Self-Hosted DataHub section; we'll need to update the link if we change the ordering of articles in the sidebar and/or if we split apart Quickstart.

@@ -0,0 +1,62 @@
# Get Started With DataHub
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The main purpose of this document is to provide the "Get Started" section with a landing page of sorts, so it's intentionally sparse.

@github-actions
Copy link

github-actions bot commented Oct 25, 2022

Unit Test Results (build & test)

599 tests  ±0   595 ✔️ ±0   11m 38s ⏱️ -6s
149 suites ±0       4 💤 ±0 
149 files   ±0       0 ±0 

Results for commit 7b45b42. ± Comparison against base commit cd1331f.

♻️ This comment has been updated with latest results.

* Deploy DataHub on your local machine
* Ingest sample data to get a feel for what is possible in DataHub
* Add and invite users to DataHub
* Troubleshoot common issues
Copy link
Contributor

Choose a reason for hiding this comment

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

Good point!


* Add and invite users to DataHub
* Configure Slack notifications
* Understand Approval Workflows
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we add set up SSO here?


* Add and invite users to DataHub
* Configure Slack notifications
* Understand Approval Workflows
Copy link
Contributor

Choose a reason for hiding this comment

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

As an alternative to add and invite users


Before you go further, ensure you have the following installed:

* [Docker](https://docs.docker.com/get-docker/)
Copy link
Contributor

Choose a reason for hiding this comment

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

We also need Python right?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Ah good point - what version do we require?

Copy link
Contributor

Choose a reason for hiding this comment

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

Looks good!

@shirshanka shirshanka merged commit 3136ad8 into datahub-project:master Oct 26, 2022
anthonyhungnguyen pushed a commit to anthonyhungnguyen/zlp-datahub that referenced this pull request Nov 8, 2022
cccs-tom pushed a commit to CybercentreCanada/datahub that referenced this pull request Nov 18, 2022
cccs-tom pushed a commit to CybercentreCanada/datahub that referenced this pull request Nov 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues and Improvements to docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants