Skip to content

website,example: remove legacy docs and fixup links#3432

Merged
joelanford merged 2 commits intooperator-framework:masterfrom
joelanford:rm-legacy-go-example-and-docs
Jul 16, 2020
Merged

website,example: remove legacy docs and fixup links#3432
joelanford merged 2 commits intooperator-framework:masterfrom
joelanford:rm-legacy-go-example-and-docs

Conversation

@joelanford
Copy link
Copy Markdown
Member

Description of the change:
Remove legacy docs and fixup links

Motivation for the change:
1.0 prep

Checklist

If the pull request includes user-facing changes, extra documentation is required:

@joelanford joelanford added the kind/documentation Categorizes issue or PR as related to documentation. label Jul 15, 2020
@joelanford joelanford added this to the v1.0.0 milestone Jul 15, 2020
[v0.1.0-migration-guide]: ../v0.1.0-migration-guide
[manifest-format]: https://github.com/operator-framework/operator-registry#manifest-format
[client-doc]: ../../golang/legacy/references/client
[client-doc]: https://v0-19-x.sdk.operatorframework.io/docs/golang/legacy/references/client/
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Good spot since it was removed from the master we need to point out to the latest release with them 👍

1. Create nginx CR and wait for it to be ready.
1. Scale up the dependent deployment and verify the operator reconciles it back down.
1. Scale up the CR and verify the dependent deployment scales up accordingly.
1. Delete nginx CR and verify that finalizer (which writes a message in the operator logs) ran.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

👍

Copy link
Copy Markdown
Contributor

@camilamacedo86 camilamacedo86 left a comment

Choose a reason for hiding this comment

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

hi @joelanford,

It shows great. just 2 nits.

  1. Should we not keep the watches implementation?
  2. Would be great if we could check that go.tmp is outdated with the PR changes? WDYT about we track an issue to see if we are able to find out a way to do it?

Otherwise,

/lgtm
/approve

@openshift-ci-robot openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Jul 15, 2020
})
if err != nil {
return err
}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hi @joelanford,

Should we not keep the watches implementation?
I think the watch feature is described where the example is used.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I:

  1. renamed example/kb-memcached-operator to example/memcached-operator
  2. removed references to the old example/memcached-operator
  3. updated references from example/kb-memcached-operator to example/memcached-operator

I didn't look at the contents of the files at all.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

So, wdyt abut add here the watches back?

@joelanford joelanford mentioned this pull request Jul 15, 2020
92 tasks
@@ -1,141 +1,98 @@
package memcached
/*
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

This file was just renamed from example/kb-memcached-operator/memcached_controller.go.tmpl

Copy link
Copy Markdown
Member

@jmrodri jmrodri left a comment

Choose a reason for hiding this comment

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

I think there's a typo, if it is please fix. If not, I'll change to approved.

[addcli]: /docs/cli/operator-sdk_add_api
<!-- TODO: update this link to the non-legacy doc once the ansible plugin is publicly available -->
[quickstart-bundle]: /docs/olm-integration/legacy/quickstart-bundle
[quickstart-bundle]:https://v0-19-x.sdk.operatorframework.io/docs/olm-integration/legacy/quickstart-bundle/
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'm assuming this is fully qualified because legacy only lives in 0.19 now.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Once the ansible operator is updated, we'll probably update this link again to point to the new KB-based bundle quickstart.

Comment thread website/content/en/docs/faq.md Outdated
@openshift-ci-robot openshift-ci-robot removed the lgtm Indicates that a PR is ready to be merged. label Jul 15, 2020
Copy link
Copy Markdown
Member

@estroz estroz left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci-robot openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Jul 15, 2020
@joelanford joelanford merged commit 5a9ca47 into operator-framework:master Jul 16, 2020
@joelanford joelanford deleted the rm-legacy-go-example-and-docs branch July 16, 2020 01:33
joelanford added a commit to joelanford/operator-sdk that referenced this pull request Jul 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants