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

Breadcrumbs on the tutorial and use-case pages #1092

Merged
merged 10 commits into from
Feb 25, 2022

Conversation

bpurkaystha
Copy link
Contributor

@bpurkaystha bpurkaystha commented Feb 25, 2022

Description

This is the Asana story. In short, this PR is about adding two breadcrumbs: Back to tutorials on each tutorial & use-case page.

Screen Shot 2022-02-25 at 10 08 45 PM

@bpurkaystha bpurkaystha changed the title Conflicts with master resolved Breadcrumbs on the tutorial page Feb 25, 2022
@bpurkaystha bpurkaystha marked this pull request as ready for review February 25, 2022 15:11
Copy link
Contributor

@ybyzek ybyzek left a comment

Choose a reason for hiding this comment

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

Thanks for the PR @bpurkaystha . The recipes need breadcrumbs too, not just tutorials (those linked from http://127.0.0.1:4000/use-cases.html)

@bpurkaystha bpurkaystha changed the title Breadcrumbs on the tutorial page Breadcrumbs on the tutorial and use-case pages Feb 25, 2022
@bpurkaystha
Copy link
Contributor Author

Hey @ybyzek , thanks for the heads up..! I had missed that from the Asana story.. Now I've added the breadcrumbs on the use-cases pages as well.

@bpurkaystha bpurkaystha requested a review from ybyzek February 25, 2022 16:28
_layouts/recipe.html Outdated Show resolved Hide resolved
_layouts/recipe.html Outdated Show resolved Hide resolved
@bpurkaystha bpurkaystha requested a review from ybyzek February 25, 2022 16:30
@ybyzek ybyzek requested a review from bbejeck February 25, 2022 16:33
Copy link
Contributor

@ybyzek ybyzek left a comment

Choose a reason for hiding this comment

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

Validated and LGTM. @danshafie @bbejeck -- did you want to take a look at this PR before we merge?

@ybyzek ybyzek requested a review from danshafie February 25, 2022 16:34
assets/sass/main.scss Outdated Show resolved Hide resolved
assets/sass/main.scss Outdated Show resolved Hide resolved
_layouts/recipe.html Outdated Show resolved Hide resolved
_layouts/tutorial.html Outdated Show resolved Hide resolved
@danshafie
Copy link
Contributor

thank you @bpurkaystha

@@ -1,23 +1,8 @@
{
"name": "kafka-tutorials",
"version": "1.0.0",
"lockfileVersion": 2,
"lockfileVersion": 1,
Copy link
Contributor

Choose a reason for hiding this comment

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

@bpurkaystha @danshafie I might have missed a comment about this, but just checking that the change to this file is intended.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It appears that I've had a different node version when installing the packages, but that should not be too much of a concern. Thanks @ybyzek

Copy link
Contributor

Choose a reason for hiding this comment

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

Since this isn't required for the PR, can you please back out these changes?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Actually, in my opinion, this should be present there in the PR. Ideally, we'd want to ensure possiblity of time-travel of the past states. That's why we should keep it included in the PR. Moreover, this lock file contributes to the performance improvement by reducing the need to read package.json itself. It should be there in the version control.

Copy link
Contributor

Choose a reason for hiding this comment

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

@bpurkaystha if the file should be updated, can we have this PR just about the breadcrumb and you can submit a separate PR for package-lock.json?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated..!

Copy link
Contributor

@colinhicks colinhicks Feb 25, 2022

Choose a reason for hiding this comment

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

I agree the lockfile change isn't a big deal. Looks like the one in master was generated by a newer version of npm (>= 7) compared to the one in the referenced commit.

Since the project doesn't specify a semver for the npm version in the package.json this sort of change is expected and should be harmless. I think the only side effect is churn in this file. If one PR changes the lockfileVersion to 1, and a developer pulls the changes, then runs npm install with a newer version of npm, there would be new changes to the lockfile. If those changes were committed, then pulled to an environment with an older npm version, running npm install would flip the version back. And so forth.

For this project and its relatively light set of node dependencies this will probably never matter (you can just accept the changes in the relevant PR), but if you want to avoid the flip-flopping, you can set something like "engines": { "npm": ">=7.0.0"} in the package.json. This should require an npm that uses the new lockfile version and avoid the flip-flop.

Copy link
Contributor

Choose a reason for hiding this comment

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

@colinhicks #1093 tracks your comment

@bpurkaystha thanks for backing out the change

@bpurkaystha bpurkaystha deleted the feature/breadcrumbs branch March 15, 2022 19:49
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.

4 participants