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

Mark many design documents defunct #2436

Merged
merged 5 commits into from
Jul 13, 2021
Merged

Mark many design documents defunct #2436

merged 5 commits into from
Jul 13, 2021

Conversation

negz
Copy link
Member

@negz negz commented Jul 13, 2021

Description of your changes

Fixes #1711

This PR moves many documents into the design/defunct directory and updates their status to "Defunct". It also removes two Upbound Cloud specific designs that belong in an Upbound repository. Finally, it explains how we're currently approaching design documents (i.e. that we don't always update them to represent the latest iteration of an implementation).

I have:

  • Read and followed Crossplane's contribution process.
  • Run make reviewable to ensure this PR is ready for review.
  • Added backport release-x.y labels to auto-backport this PR if necessary.

How has this code been tested

N/A.

negz added 4 commits July 13, 2021 21:33
These documents are just that. I'm also moving them into a directory to more
clearly distinguish which design docs are still relevant.

Signed-off-by: Nic Cope <negz@rk0n.org>
Upbound Cloud actually still respects this spec, but the design is Upbound
specific and thus belongs under the github.com/upbound org - perhaps in the
Universal Crossplane repository.

Signed-off-by: Nic Cope <negz@rk0n.org>
We have a few design documents that are still mostly accurate and interesting
when it comes to describing problems we've wanted to solve, but that either
mention defunct concepts (e.g. resource classes) or go into detail about the
initial rather than the current technical implementation of a problem (e.g. the
code examples in the cross resource references document).

Signed-off-by: Nic Cope <negz@rk0n.org>
@negz negz requested a review from hasheddan July 13, 2021 21:55
Copy link
Member

@hasheddan hasheddan left a comment

Choose a reason for hiding this comment

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

Thanks for doing this @negz -- I think this will make things a lot clearer for users. This looks good, though I think a number of image links in these defunct documents may now be broken.

I broke a bunch of these in a previous commit by moving design docs into the
defunct directory.

Signed-off-by: Nic Cope <negz@rk0n.org>
@negz
Copy link
Member Author

negz commented Jul 13, 2021

I think a number of image links in these defunct documents may now be broken.

Ah good catch - I pushed a commit to fix those.

@negz negz merged commit e14a6fb into crossplane:master Jul 13, 2021
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 this pull request may close these issues.

Cleanup design doc lifecycles
2 participants