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

Migrate documentation: Remove docs from etcd-io/etcd #97

Closed
nate-double-u opened this issue Jan 27, 2021 · 9 comments · Fixed by etcd-io/etcd#12660
Closed

Migrate documentation: Remove docs from etcd-io/etcd #97

nate-double-u opened this issue Jan 27, 2021 · 9 comments · Fixed by etcd-io/etcd#12660

Comments

@nate-double-u
Copy link
Contributor

nate-double-u commented Jan 27, 2021

Description

As per the conversation around the Etcd.io Docs/SEO Improvement Plan:

Replace existing documentation in etcd-io/etcd repo with signposts to new location on website (etcd.io).

Deliverable

etcd-io/etcd Documentation folder points to etcd.io/docs

Notes

@nate-double-u
Copy link
Contributor Author

nate-double-u commented Jan 28, 2021

/cc @spzala @jberkus

I think removal of these docs from the etcd-io/etcd repo can go a couple ways:

  1. Dex IdP model: where all the .md files were removed, and the top level documentation/README.md was altered with a note that the documentation files had moved to the website repo
  2. CNI Plugins model: where each individual file that got moved was edited with a link to its new home on the website.

I'd suggest (1), but am happy to go with (2) if people prefer it. I'm also open to other suggestions.

@spzala
Copy link
Member

spzala commented Jan 28, 2021

/cc @xiang90 @gyuho @jingyih

nate-double-u added a commit to nate-double-u/etcd that referenced this issue Feb 1, 2021
Leaving docs, files, etc that are required for generated documentation

fixes etcd-io/website#97

Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>
nate-double-u added a commit to nate-double-u/etcd that referenced this issue Feb 10, 2021
Leaving docs, files, etc that are required for generated documentation

fixes etcd-io/website#97

Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>
@rohitdurvasula
Copy link

@nate-double-u any idea where does the etcd-mixin folder inside Documentation folder now reside ?

https://github.com/prometheus-operator/kube-prometheus used to depend on that.

@spzala
Copy link
Member

spzala commented Feb 10, 2021

@nate-double-u
Copy link
Contributor Author

If that location doesn't work and it needs to be back in this repo, let us know and we can see about restoring it. There are still a couple folders/files that have stayed in the Documentation folder here as they are a part of an automated system.

@underrun
Copy link

this breaks installs of kube-prometheus and anyone else who may have depended on that jsonnet library.

really it was never documentation... please restore it :-)

@nate-double-u
Copy link
Contributor Author

I'll open a new PR to restore etcd-mixin shortly

nate-double-u added a commit to nate-double-u/etcd that referenced this issue Feb 10, 2021
Restoring Documentation/etcd-mixin folder for kube-prometheus use as per conversations in issue etcd-io/website#97

Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>
@nate-double-u
Copy link
Contributor Author

really it was never documentation...

We may want to open a separate issue at some point to move this out of the Documentation folder -- if it isn't documentation it's probably in the wrong spot.

@spzala
Copy link
Member

spzala commented Feb 11, 2021

@nate-double-u yeah, we should. And also, we can comment it in the files about how they are being used.

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 a pull request may close this issue.

4 participants