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

docs: rephrasing the hubble intro doc #27712

Merged
merged 1 commit into from Sep 12, 2023
Merged

docs: rephrasing the hubble intro doc #27712

merged 1 commit into from Sep 12, 2023

Conversation

vipul-21
Copy link
Contributor

Please ensure your pull request adheres to the following guidelines:

  • For first time contributors, read Submitting a pull request
  • All code is covered by unit and/or runtime tests where feasible.
  • All commits contain a well written commit description including a title,
    description and a Fixes: #XXX line if the commit addresses a particular
    GitHub issue.
  • If your commit description contains a Fixes: <commit-id> tag, then
    please add the commit author[s] as reviewer[s] to this issue.
  • All commits are signed off. See the section Developer’s Certificate of Origin
  • Provide a title or release-note blurb suitable for the release notes.
  • Are you a user of Cilium? Please add yourself to the Users doc
  • Thanks for contributing!

Rephrasing the doc to make sure to avoid duplication

Fixes: #14587

@vipul-21 vipul-21 requested review from a team as code owners August 25, 2023 18:42
@maintainer-s-little-helper maintainer-s-little-helper bot added the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Aug 25, 2023
@github-actions github-actions bot added the kind/community-contribution This was a contribution made by a community member. label Aug 25, 2023
@vipul-21
Copy link
Contributor Author

@joestringer can you take a look at this when you have time.

@vipul-21 vipul-21 force-pushed the doc_change branch 2 times, most recently from 218668b to 8fed4fd Compare August 25, 2023 19:27
@joestringer
Copy link
Member

@vipul-21 I don't review all PRs, GitHub has assigned CODEOWNERS for the relevant areas to review. As @cilium/tophat for the week I'll trigger CI for you 👍

@joestringer joestringer added release-note/misc This PR makes changes that have no direct user impact. needs-backport/1.14 This PR / issue needs backporting to the v1.14 branch labels Aug 25, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot removed the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Aug 25, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from main in 1.14.2 Aug 25, 2023
@joestringer
Copy link
Member

/test

@joestringer joestringer added the needs-backport/1.13 This PR / issue needs backporting to the v1.13 branch label Aug 25, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from main in 1.13.7 Aug 25, 2023
lambdanis
lambdanis requested changes Aug 28, 2023
View reviewed changes
Copy link
Contributor

@lambdanis lambdanis left a comment

Choose a reason for hiding this comment

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

Thanks @vipul-21, I left a few suggestions. Could you also put reasoning for the change in the commit message? Based on the linked issue, I understand the change is done to reduce duplication between the two paragraphs.

Documentation/gettingstarted/hubble_intro.rst Outdated Show resolved Hide resolved
Documentation/gettingstarted/hubble_intro.rst Outdated Show resolved Hide resolved
Documentation/gettingstarted/hubble_intro.rst Outdated Show resolved Hide resolved
Documentation/gettingstarted/hubble_intro.rst Outdated Show resolved Hide resolved
chancez
chancez requested changes Aug 28, 2023
View reviewed changes
Copy link
Contributor

@chancez chancez left a comment

Choose a reason for hiding this comment

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

Can you squash your commits together?

@vipul-21 @lambdanis
docs: rephrasing the hubble intro doc
3c47096 
To reduce the duplication between the two paragraphs of hubble intro doc.

Co-authored-by: Anna Kapuścińska <ania0102@gmail.com>
Signed-off-by: Vipul Singh <vipul21sept@gmail.com>
chancez
chancez approved these changes Aug 28, 2023
View reviewed changes
Copy link
Contributor

@chancez chancez left a comment

Choose a reason for hiding this comment

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

Thanks!

@michi-covalent michi-covalent added this to Needs backport from main in 1.14.3 Sep 9, 2023
@michi-covalent michi-covalent removed this from Needs backport from main in 1.14.2 Sep 9, 2023
@michi-covalent michi-covalent added this to Needs backport from main in 1.13.8 Sep 9, 2023
@michi-covalent michi-covalent removed this from Needs backport from main in 1.13.7 Sep 9, 2023
@julianwiedmann julianwiedmann added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. sig/hubble Impacts hubble server or relay labels Sep 12, 2023
@julianwiedmann julianwiedmann merged commit 258e87c into cilium:main Sep 12, 2023
40 checks passed
@gandro gandro mentioned this pull request Sep 12, 2023
Merged
15 tasks
@gandro gandro added backport-pending/1.14 The backport for Cilium 1.14.x for this PR is in progress. and removed needs-backport/1.14 This PR / issue needs backporting to the v1.14 branch labels Sep 12, 2023
@gandro gandro mentioned this pull request Sep 12, 2023
Merged
6 tasks
@gandro gandro added backport-pending/1.13 The backport for Cilium 1.13.x for this PR is in progress. and removed needs-backport/1.13 This PR / issue needs backporting to the v1.13 branch labels Sep 12, 2023
@julianwiedmann julianwiedmann added backport-done/1.13 The backport for Cilium 1.13.x for this PR is done. and removed backport-pending/1.13 The backport for Cilium 1.13.x for this PR is in progress. labels Sep 14, 2023
@gandro gandro added backport-done/1.14 The backport for Cilium 1.14.x for this PR is done. and removed backport-pending/1.14 The backport for Cilium 1.14.x for this PR is in progress. labels Sep 25, 2023
@jrajahalme jrajahalme moved this from Needs backport from main to Backport done to v1.13 in 1.13.8 Oct 17, 2023
@jrajahalme jrajahalme removed this from Needs backport from main in 1.14.3 Oct 17, 2023
This was referenced Oct 17, 2023
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chancez chancez chancez approved these changes

@lambdanis lambdanis lambdanis approved these changes

Assignees
No one assigned
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. backport-done/1.13 The backport for Cilium 1.13.x for this PR is done. backport-done/1.14 The backport for Cilium 1.14.x for this PR is done. kind/community-contribution This was a contribution made by a community member. release-note/misc This PR makes changes that have no direct user impact. sig/hubble Impacts hubble server or relay
Projects
No open projects
1.13.8
Backport done to v1.13
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Observability documentation duplicates text
6 participants
@vipul-21 @joestringer @chancez @lambdanis @gandro @julianwiedmann