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

MINOR - Update Developers documentation to make it easier to follow #14754

Merged
merged 2 commits into from
Jan 18, 2024
Merged

MINOR - Update Developers documentation to make it easier to follow #14754

merged 2 commits into from
Jan 18, 2024

Conversation

IceS2
Copy link
Contributor

@IceS2 IceS2 commented Jan 17, 2024

Describe your changes:

Minor update to developers documentation to make it easier to follow:

  • Updated stale information on how to load sample data
  • Added small part on how to run the OpenMetadata server directly by running the shell script
  • Reordered the sections to avoid having to jump down and up the code a couple times

Type of change:

  • Documentation

Checklist:

  • I have read the CONTRIBUTING document.
  • My PR title is Fixes <issue-number>: <short explanation>
  • I have commented on my code, particularly in hard-to-understand areas.
  • For JSON Schema changes: I updated the migration scripts or explained why it is not needed.

@github-actions github-actions bot added documentation Improvements or additions to documentation Ingestion safe to test Add this label to run secure Github workflows on PRs labels Jan 17, 2024
@IceS2 IceS2 requested a review from pmbrull January 17, 2024 09:29
@pmbrull pmbrull merged commit 69bf469 into main Jan 18, 2024
19 checks passed
@pmbrull pmbrull deleted the update-stale-documentation branch January 18, 2024 07:50
Abhishek332 pushed a commit to Abhishek332/OpenMetadata that referenced this pull request Jan 25, 2024
@IceS2 @Abhishek332
MINOR - Update Developers documentation to make it easier to follow (o…
6c3db43 
…pen-metadata#14754)

* chore(docs): Changed the structure of the file to facilitate following it

* fix(docs): Add missing cd command before starting the server from script
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pmbrull pmbrull pmbrull approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation Ingestion safe to test Add this label to run secure Github workflows on PRs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@IceS2 @pmbrull