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

feat(docs-site): fast reload command for markdown edits #6539

Merged
merged 1 commit into from
Nov 29, 2022

Conversation

hsheth2
Copy link
Collaborator

@hsheth2 hsheth2 commented Nov 23, 2022

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

@hsheth2 hsheth2 changed the title feat(docs): fast reload command for markdown edits feat(docs-site): fast reload command for markdown edits Nov 23, 2022
@github-actions
Copy link

Unit Test Results (build & test)

621 tests  ±0   617 ✔️ ±0   15m 48s ⏱️ +4s
157 suites ±0       4 💤 ±0 
157 files   ±0       0 ±0 

Results for commit 4513814. ± Comparison against base commit a400eb0.

@@ -15,7 +15,7 @@ const GITHUB_EDIT_URL =
const GITHUB_BROWSE_URL =
"https://github.com/datahub-project/datahub/blob/master";

const OUTPUT_DIRECTORY = "genDocs";
const OUTPUT_DIRECTORY = "docs";
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why do we need to change the location from genDocs to docs?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

It now generates into docs and then copies into genDocs from the other scripts. This way we don’t have to purge the whole genDocs directory before hot rebuilding.

Copy link
Collaborator

@jjoyce0510 jjoyce0510 left a comment

Choose a reason for hiding this comment

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

LGTM..

@hsheth2 hsheth2 merged commit d4bf6ce into datahub-project:master Nov 29, 2022
@hsheth2 hsheth2 deleted the docs-fast-reload branch November 29, 2022 05:52
cccs-Dustin pushed a commit to CybercentreCanada/datahub that referenced this pull request Feb 1, 2023
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.

None yet

2 participants