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

1.8 documentation updates: Concepts & menu structure #11979

Merged
merged 17 commits into from Jun 17, 2020
Merged

Conversation

tgraf
Copy link
Member

@tgraf tgraf commented Jun 9, 2020

No description provided.

@tgraf tgraf added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. release-note/misc This PR makes changes that have no direct user impact. needs-backport/1.8 labels Jun 9, 2020
@tgraf tgraf requested a review from a team as a code owner June 9, 2020 11:03
@maintainer-s-little-helper maintainer-s-little-helper bot added this to In progress in 1.8.0 Jun 9, 2020
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from master in 1.8.0 Jun 9, 2020
@tgraf tgraf marked this pull request as draft June 9, 2020 11:03
@coveralls
Copy link

coveralls commented Jun 9, 2020

Coverage Status

Coverage decreased (-0.02%) to 37.072% when pulling 3515246 on pr/tgraf/1.8-docs into bf64aa9 on master.

@tgraf tgraf force-pushed the pr/tgraf/1.8-docs branch 3 times, most recently from c809196 to 9f1823c Compare June 9, 2020 15:56
Copy link
Member

@joestringer joestringer left a comment

Choose a reason for hiding this comment

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

Some minor comments as a first pass.

Documentation/concepts/ipam/cluster-pool.rst Outdated Show resolved Hide resolved
Documentation/concepts/networking/routing.rst Outdated Show resolved Hide resolved
Documentation/concepts/networking/routing.rst Outdated Show resolved Hide resolved
Documentation/concepts/networking/routing.rst Outdated Show resolved Hide resolved
Documentation/concepts/networking/routing.rst Show resolved Hide resolved
Copy link
Member

@christarazi christarazi left a comment

Choose a reason for hiding this comment

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

First-pass comments, looks good overall

Documentation/concepts/ipam/deep_dive.rst Outdated Show resolved Hide resolved
Documentation/concepts/ipam/index.rst Outdated Show resolved Hide resolved
Documentation/concepts/networking/masquerading.rst Outdated Show resolved Hide resolved
Documentation/concepts/networking/masquerading.rst Outdated Show resolved Hide resolved
Documentation/concepts/networking/routing.rst Outdated Show resolved Hide resolved
Documentation/concepts/networking/routing.rst Outdated Show resolved Hide resolved
Documentation/concepts/networking/routing.rst Outdated Show resolved Hide resolved
Documentation/concepts/overview.rst Show resolved Hide resolved
Documentation/concepts/overview.rst Outdated Show resolved Hide resolved
Documentation/concepts/overview.rst Outdated Show resolved Hide resolved
@tgraf tgraf force-pushed the pr/tgraf/1.8-docs branch 2 times, most recently from 04011b5 to 0bcd132 Compare June 10, 2020 14:14
@joestringer joestringer self-requested a review June 10, 2020 16:21
@christarazi christarazi self-requested a review June 11, 2020 05:36
@tgraf tgraf marked this pull request as ready for review June 11, 2020 08:19
@tgraf tgraf requested a review from a team June 11, 2020 08:19
@tgraf tgraf requested a review from a team as a code owner June 11, 2020 08:19
@tgraf tgraf force-pushed the pr/tgraf/1.8-docs branch 2 times, most recently from da20b5d to 34c7d5f Compare June 11, 2020 10:04
@tgraf tgraf changed the title [WIP] 1.8 documentation updates 1.8 documentation updates: Concepts & menu structure Jun 11, 2020
@aanm aanm added the dont-merge/needs-rebase This PR needs to be rebased because it has merge conflicts. label Jun 11, 2020
@tgraf
Copy link
Member Author

tgraf commented Jun 11, 2020

I will wait with the rebase until final reviews come in

Documentation/intro.rst Outdated Show resolved Hide resolved
Documentation/intro.rst Outdated Show resolved Hide resolved
Documentation/concepts/overview.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@michi-covalent michi-covalent left a comment

Choose a reason for hiding this comment

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

reviewed:

  • Documentation/intro.rst
  • Documentation/index.rst
  • Documentation/concepts/overview.rst

Documentation/concepts/overview.rst Outdated Show resolved Hide resolved
Documentation/concepts/ipam/index.rst Outdated Show resolved Hide resolved
Documentation/gettingstarted/mesos.rst Show resolved Hide resolved
Documentation/gettingstarted/mesos.rst Show resolved Hide resolved
Documentation/concepts/overview.rst Outdated Show resolved Hide resolved
Documentation/intro.rst Outdated Show resolved Hide resolved
Documentation/concepts/ebpf/iptables.rst Outdated Show resolved Hide resolved
Documentation/concepts/ebpf/lifeofapacket.rst Show resolved Hide resolved
Documentation/concepts/ebpf/lifeofapacket.rst Outdated Show resolved Hide resolved
Documentation/concepts/security/intro.rst Outdated Show resolved Hide resolved
Documentation/concepts/security/intro.rst Outdated Show resolved Hide resolved
tgraf added 11 commits June 17, 2020 15:07
Signed-off-by: Thomas Graf <thomas@cilium.io>
Signed-off-by: Thomas Graf <thomas@cilium.io>
Signed-off-by: Thomas Graf <thomas@cilium.io>
Also removes the oudated Kubernetes section.

Signed-off-by: Thomas Graf <thomas@cilium.io>
Signed-off-by: Thomas Graf <thomas@cilium.io>
Signed-off-by: Thomas Graf <thomas@cilium.io>
It only refers to the getting started guide

Signed-off-by: Thomas Graf <thomas@cilium.io>
The information is duplicated from the getting started guide.

Signed-off-by: Thomas Graf <thomas@cilium.io>
Signed-off-by: Thomas Graf <thomas@cilium.io>
Signed-off-by: Thomas Graf <thomas@cilium.io>
Also removes an outdated section about future roadmap

Signed-off-by: Thomas Graf <thomas@cilium.io>
@tgraf tgraf merged commit cdf6b3b into master Jun 17, 2020
1.8.0 automation moved this from In progress to Merged Jun 17, 2020
@tgraf tgraf deleted the pr/tgraf/1.8-docs branch June 17, 2020 13:31
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Needs backport from master to Backport pending to v1.8 in 1.8.0 Jun 18, 2020
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Needs backport from master to Backport pending to v1.8 in 1.8.0 Jun 18, 2020
tklauser added a commit that referenced this pull request Jun 18, 2020
The documentation about the BPF map scale and limitation is currently
duplicated. The version in the "Introduction" section (intro.rst) was
updated with the most recent changes, while the version in the "Maps"
section (which was split out in #11979 into maps.rst) contains an
outdated version.  Move all the up-to-date info to maps.rst.
Incidentally, this also makes the last sentence in the previous section
"Below we show the following possible flows..." make sense again since
it refers to the figure in section "Kubernetes Integration".

Signed-off-by: Tobias Klauser <tklauser@distanz.ch>
joestringer pushed a commit that referenced this pull request Jun 18, 2020
The documentation about the BPF map scale and limitation is currently
duplicated. The version in the "Introduction" section (intro.rst) was
updated with the most recent changes, while the version in the "Maps"
section (which was split out in #11979 into maps.rst) contains an
outdated version.  Move all the up-to-date info to maps.rst.
Incidentally, this also makes the last sentence in the previous section
"Below we show the following possible flows..." make sense again since
it refers to the figure in section "Kubernetes Integration".

Signed-off-by: Tobias Klauser <tklauser@distanz.ch>
borkmann pushed a commit that referenced this pull request Jun 18, 2020
[ upstream commit 3ab3d68 ]

The documentation about the BPF map scale and limitation is currently
duplicated. The version in the "Introduction" section (intro.rst) was
updated with the most recent changes, while the version in the "Maps"
section (which was split out in #11979 into maps.rst) contains an
outdated version.  Move all the up-to-date info to maps.rst.
Incidentally, this also makes the last sentence in the previous section
"Below we show the following possible flows..." make sense again since
it refers to the figure in section "Kubernetes Integration".

Signed-off-by: Tobias Klauser <tklauser@distanz.ch>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
borkmann pushed a commit that referenced this pull request Jun 18, 2020
[ upstream commit 3ab3d68 ]

The documentation about the BPF map scale and limitation is currently
duplicated. The version in the "Introduction" section (intro.rst) was
updated with the most recent changes, while the version in the "Maps"
section (which was split out in #11979 into maps.rst) contains an
outdated version.  Move all the up-to-date info to maps.rst.
Incidentally, this also makes the last sentence in the previous section
"Below we show the following possible flows..." make sense again since
it refers to the figure in section "Kubernetes Integration".

Signed-off-by: Tobias Klauser <tklauser@distanz.ch>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Backport pending to v1.8 to Backport done to v1.8 in 1.8.0 Jun 18, 2020
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Backport pending to v1.8 to Backport done to v1.8 in 1.8.0 Jun 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. release-note/misc This PR makes changes that have no direct user impact.
Projects
No open projects
1.8.0
  
Merged
1.8.0
Backport done to v1.8
Development

Successfully merging this pull request may close these issues.

None yet

9 participants