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-website): add vercel preview environment #7644

Merged
merged 18 commits into from
Mar 22, 2023

Conversation

hsheth2
Copy link
Collaborator

@hsheth2 hsheth2 commented Mar 20, 2023

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 devops PR or Issue related to DataHub backend & deployment label Mar 20, 2023
@hsheth2 hsheth2 marked this pull request as ready for review March 21, 2023 00:52
@hsheth2 hsheth2 changed the title feat(docs-website): add vercel preview environments feat(docs-website): add vercel preview environment Mar 21, 2023
@vercel vercel bot temporarily deployed to Preview March 21, 2023 04:07 Inactive
@vercel vercel bot temporarily deployed to Preview March 21, 2023 04:12 Inactive
@vercel vercel bot temporarily deployed to Preview March 21, 2023 04:27 Inactive
@vercel vercel bot temporarily deployed to Preview March 21, 2023 06:15 Inactive
@vercel vercel bot temporarily deployed to Preview March 21, 2023 08:07 Inactive
Copy link
Collaborator

@asikowitz asikowitz left a comment

Choose a reason for hiding this comment

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

A few questions for my understanding

@@ -31,3 +31,4 @@ npm-debug.log*
yarn-debug.log*
yarn-error.log*
.vscode
.vercel
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do we need both this and above?

Comment on lines +7 to +10
sudo_cmd=""
if command -v sudo; then
sudo_cmd="sudo"
fi
Copy link
Collaborator

Choose a reason for hiding this comment

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

Not sure if we care, but this will print the result of command -v sudo to stdout. Can either pipe into /dev/null or check [ -x "$(command -v sudo)" ] as per https://stackoverflow.com/questions/592620/how-can-i-check-if-a-program-exists-from-a-bash-script

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 I didn't realize that

In this case I don't think we care because it's just the path to sudo and that script is only run in CI

Sinks: [
{
type: "autogenerated",
dirName: "metadata-ingestion/sink_docs",
Copy link
Collaborator

Choose a reason for hiding this comment

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

How come these are in a different place from the source docs?

dirName: "docs/generated/ingestion/sources"

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 source docs are generated by another build script, whereas these are raw md files

@@ -1,34 +1,3 @@
const fs = require("fs");

function list_ids_in_directory(directory, hardcoded_labels) {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nice

"silent": true,
"autoJobCancelation": true
},
"installCommand": "amazon-linux-extras install python3.8 && py3=\"$(which python3)\" && rm \"$py3\" && ln \"$(which python3.8)\" \"$py3\" && ./metadata-ingestion/scripts/install_deps.sh && yum install -y gcc python38-devel",
Copy link
Collaborator

Choose a reason for hiding this comment

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

How come we're using python3.8 here? And what is running this command?

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 command is being run by vercel, which is a third-party tool

@hsheth2 hsheth2 merged commit d9231ad into datahub-project:master Mar 22, 2023
@hsheth2 hsheth2 deleted the vercel-deploy branch March 22, 2023 19:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devops PR or Issue related to DataHub backend & deployment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants