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

Stateless example in docs should use be reviewed #22918

Closed
castrojo opened this issue Aug 2, 2020 · 16 comments
Closed

Stateless example in docs should use be reviewed #22918

castrojo opened this issue Aug 2, 2020 · 16 comments
Assignees
@castrojo @paulczar
Labels
kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. sig/docs Categorizes an issue or PR as relevant to SIG Docs. wg/naming Categorizes an issue or PR as relevant to WG Naming.

Comments

@castrojo
Copy link
Member

castrojo commented Aug 2, 2020

So I'm in the middle of a workshop with students using K8s and the example workshop links to this tutorial:

I did some digging and this terminology still seems to be an issue that redis hasn't solved so I'm wondering if we should just find someone to redo this with a stateless example that just avoids redis altogether. Either way just wanted to get this on the radar as it's received complaints.
@castrojo
Copy link
Member Author

castrojo commented Aug 2, 2020

/assign

Unless anyone feels strongly otherwise I'm going to find someone with the technical expertise to fix this as soon as we can.

@cblecker cblecker transferred this issue from kubernetes/community Aug 2, 2020
@cblecker
Copy link
Member

cblecker commented Aug 2, 2020

/sig docs
/wg naming

cc @kubernetes/sig-docs-en-owners @kubernetes/wg-naming

Yeah, this example could be re-done without the use of redis if need be.

@k8s-ci-robot k8s-ci-robot added sig/docs Categorizes an issue or PR as relevant to SIG Docs. wg/naming Categorizes an issue or PR as relevant to WG Naming. labels Aug 2, 2020
@cblecker
Copy link
Member

cblecker commented Aug 2, 2020

It looks like this example might also just be broken?

ref #19821 #20088

@castrojo
Copy link
Member Author

castrojo commented Aug 3, 2020

/assign @paulczar

Paul's agreed to look at the example and work on a PR.

paulczar added a commit to paulczar/website that referenced this issue Aug 3, 2020
@paulczar
Remove Master/Slave terminology from stateless application tutorial.
cdafdb9 
The stateless application tutorial is littered with unsuitable terminology. This update switches the database technology to a database that has already updated their own terminology as well as removes the terminology from the tutorial itself.

The advanced logging tutorial followup is set to Draft as it will take a larger effort to convert that, and I'm not convinced its even in a working state right now.

A followup PR to the examples repo to be referenced here will be made.

Addresses kubernetes#22918

Signed-off-by: Paul Czarkowski <[email protected]>
@paulczar paulczar mentioned this issue Aug 3, 2020
Closed
paulczar added a commit to paulczar/examples that referenced this issue Aug 3, 2020
@paulczar
Update guestbook example to remove inappropriate terminology
d5f5aec 
The guestbook and redis documentation are littered with master/slave terminology. This update along with the update to the [website](kubernetes/website#22934) removes that terminology and technology.

Addresses kubernetes/website#22918

Signed-off-by: Paul Czarkowski <[email protected]>
@paulczar paulczar mentioned this issue Aug 3, 2020
Closed
@paulczar
Copy link
Contributor

paulczar commented Aug 3, 2020

@castrojo PR made to both the website and the examples repos. One followup is needed which is to upload the newly built example image to a suitable location that isn't my personal dockerhub repo.

@sftim
Copy link
Contributor

sftim commented Aug 3, 2020

Redis has switched away from using the term “slave” so I'm wondering if this change is needed.
WG Naming - does this need fixing? Add /priority xxx if it's passed triage.

@kbhawkey
Copy link
Contributor

kbhawkey commented Aug 4, 2020

I understand the rationale for changing this tutorial; however, is it worthwhile to investigate if it is possible to modify the terminology and naming of the example files, fields, and images.

@sftim
Copy link
Contributor

sftim commented Aug 6, 2020

/kind cleanup
/priority important-longterm

@k8s-ci-robot k8s-ci-robot added kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. labels Aug 6, 2020
@sftim
Copy link
Contributor

sftim commented Aug 6, 2020

@kbhawkey has put it better than I did in #22918 (comment)

The existing page is wrong; I wonder if we need to change the product as well as fix the wording?

@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Nov 4, 2020
@kbhawkey
Copy link
Contributor

kbhawkey commented Nov 4, 2020

/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Nov 4, 2020
@jimangel jimangel mentioned this issue Jan 19, 2021
Closed
jimangel pushed a commit to jimangel/website that referenced this issue Jan 19, 2021
@paulczar @jimangel
Remove Master/Slave terminology from stateless application tutorial.
99029b9 
The stateless application tutorial is littered with unsuitable terminology. This update switches the database technology to a database that has already updated their own terminology as well as removes the terminology from the tutorial itself.

The advanced logging tutorial followup is set to Draft as it will take a larger effort to convert that, and I'm not convinced its even in a working state right now.

A followup PR to the examples repo to be referenced here will be made.

Addresses kubernetes#22918

Signed-off-by: Paul Czarkowski <[email protected]>

address comments in PR

Signed-off-by: Paul Czarkowski <[email protected]>

remove confusing comment about dns, we can assume k8s has kube-dns

Signed-off-by: Paul Czarkowski <[email protected]>
@jimangel jimangel mentioned this issue Jan 19, 2021
Merged
@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Feb 2, 2021
@kbhawkey
Copy link
Contributor

kbhawkey commented Feb 3, 2021

Since this should be fixed soon,
/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Feb 3, 2021
@justaugustus
Copy link
Member

PR opened here: kubernetes/examples#410

Cweiping pushed a commit to Cweiping/website that referenced this issue Feb 9, 2021
@paulczar
Remove Master/Slave terminology from stateless application tutorial.
064b588 
The stateless application tutorial is littered with unsuitable terminology. This update switches the database technology to a database that has already updated their own terminology as well as removes the terminology from the tutorial itself.

The advanced logging tutorial followup is set to Draft as it will take a larger effort to convert that, and I'm not convinced its even in a working state right now.

A followup PR to the examples repo to be referenced here will be made.

Addresses kubernetes#22918

Signed-off-by: Paul Czarkowski <[email protected]>

address comments in PR

Signed-off-by: Paul Czarkowski <[email protected]>

remove confusing comment about dns, we can assume k8s has kube-dns

Signed-off-by: Paul Czarkowski <[email protected]>
@jailton jailton mentioned this issue Mar 15, 2021
Merged
@celestehorgan
Copy link
Contributor

@castrojo – Can we close this? 👀 looks like work is done.

@castrojo
Copy link
Member Author

Woo hoo! Thanks Celeste!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@castrojo castrojo

@paulczar paulczar

Labels
kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. sig/docs Categorizes an issue or PR as relevant to SIG Docs. wg/naming Categorizes an issue or PR as relevant to WG Naming.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
9 participants
@justaugustus @castrojo @cblecker @kbhawkey @paulczar @celestehorgan @k8s-ci-robot @sftim @fejta-bot