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

Update import-a-project-by-git-url.md #5419

Merged
merged 13 commits into from
Jun 6, 2024
Merged

Update import-a-project-by-git-url.md #5419

merged 13 commits into from
Jun 6, 2024

Conversation

wusanny
Copy link
Contributor

@wusanny wusanny commented May 1, 2024

What are you changing in this pull request and why?

Adding an optional step 5 under AWS CodeCommit.
When customers (and myself) import CodeCommit repo via Git URL, the PR URL field did not auto populate. As such in the IDE, we were prompted to merge directly to primary branch. We needed to add the URL manually.

It is a common and good practice to open a PR for code changes to be reviewed before merging them into default branch. Since importing via Git URL for CodeCommit does not auto-populate the field, it would be good if we can give a heads up to our customers about it.

Checklist

Adding or removing pages (delete if not applicable):

  • Add/remove page in website/sidebars.js
  • Provide a unique filename for new pages
  • Add an entry for deleted pages in website/vercel.json
  • Run link testing locally with npm run build to update the links that point to deleted pages

adding an optional step 5, as when customers (and myself) import codecommit repo via git url, the PR URL field did not auto populate. It was an added manual step that needed to be done.

(I am not sure how to place the image in the center, sorry!)
@wusanny wusanny requested a review from a team as a code owner May 1, 2024 04:00
Copy link

vercel bot commented May 1, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-getdbt-com ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 6, 2024 9:03am

@github-actions github-actions bot added content Improvements or additions to content size: small This change will take 1 to 2 days to address labels May 1, 2024
@mirnawong1
Copy link
Contributor

hey @wusanny thanks so much for opening this! happy to take a look and posting some of the questions i had here as well:

  • should step 5 be optional?
  • also is this something product is aware of? if i’m understanding this right - it sounds like we’re asking users to manually add/update the pr template - why isn’t the pr template done automatically? it says it’s meant to here if done via git clone?

- Replace `<repo>` with the name of your repository (note that it is case sensitive).
<Lightbox src="/img/docs/collaborate/pr-template-example.jpg" width="60%" title="Configure PR Template URLs" />
- Replace `<repo>` with the name of your repository (note that it is case sensitive).
- Click **Save**.
Copy link
Contributor

Choose a reason for hiding this comment

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

@wusanny do users have to refresh the ide? i think so, yea?

- In the **Pull request URL** field, set the URL based on the suggested [PR template format](/docs/collaborate/git/pr-template#aws-codecommit).
- Replace `<repo>` with the name of your repository (note that it is case sensitive).
<Lightbox src="/img/docs/collaborate/pr-template-example.jpg" width="60%" title="Configure PR Template URLs" />
- Replace `<repo>` with the name of your repository (note that it is case sensitive).
Copy link
Contributor

Choose a reason for hiding this comment

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

love this - thanks for adding that detail about case sensitive!

Copy link
Contributor

@mirnawong1 mirnawong1 left a comment

Choose a reason for hiding this comment

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

great job @wusanny ! love this contribution and it's super clear! I'm going to go ahead and approve this for you, however i do wonder if we should raise this with product or check if this is expected behavior? this sounds like a workaround - so shouldn't the template be automatically filled out? we don't really want users merging code changes directly to the default branch.

so i made some tweaks to the pr and they include, let me know what you think!:

  • bolding the dbt cloud UI elements/pages
  • adding the images to the img folder.
  • breaking down the steps further

Screenshot 2024-05-01 at 11 45 31

@mirnawong1
Copy link
Contributor

as an update, @wusanny has tested this and we've raised this to product. refer to slack thread here: https://dbt-labs.slack.com/archives/CSSHB76QL/p1717147442123369?thread_ts=1714581453.391999&cid=CSSHB76QL to see how the convo goes and whether we want to add this to the doc itself or clarify the behavior.

Copy link
Contributor

@mirnawong1 mirnawong1 left a comment

Choose a reason for hiding this comment

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

confirmed this is a feature request, not a bug. clarifying further and approving/merging for @wusanny

@mirnawong1 mirnawong1 merged commit 82cc6e8 into current Jun 6, 2024
11 checks passed
@mirnawong1 mirnawong1 deleted the wusanny-patch-1 branch June 6, 2024 09:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content size: small This change will take 1 to 2 days to address
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants