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

Add general design goals doc #1152

Merged
merged 1 commit into from Dec 13, 2019
Merged

Add general design goals doc #1152

merged 1 commit into from Dec 13, 2019

Conversation

njhale
Copy link
Member

@njhale njhale commented Nov 25, 2019 •
edited

Description of the change:

  • Add a doc to express some general design goals for new features
  • Rename doc directory to docs

@openshift-ci-robot openshift-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Nov 25, 2019
@njhale njhale added the kind/documentation Categorizes issue or PR as related to documentation. label Nov 25, 2019
kevinrizza
kevinrizza reviewed Nov 26, 2019
View reviewed changes
Copy link
Member

@kevinrizza kevinrizza left a comment

Choose a reason for hiding this comment

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

Just had one small comment. I think this works well and should be a helpful pointer.

docs/design/design-goals.md Outdated

## Build (reasonably) small, sharp features

All designs should be kept as simple and tightly scoped as is reasonably possible. Where possible, attempt to follow the [unix philosophy](https://en.wikipedia.org/wiki/Unix_philosophy) for writing small, sharp features that compose well. Additionally, when writing a new proposal, always remember to [keep it simple ...student!](https://en.wikipedia.org/wiki/KISS_principle)
Copy link
Member

Choose a reason for hiding this comment

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

Just thinking out loud: Should we have a more formal process wrt design proposals here? What about https://github.com/operator-framework/enhancements ?

Copy link
Member Author

Choose a reason for hiding this comment

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

I agree -- but I want to keep this doc more abstract. Could we add it in a separate dev-process doc?

@ecordell
Copy link
Member

Rename doc directory to docs

this will require some link updates in places we don't own. @adellape do you think you know where these might be?

@adellape
Copy link

adellape commented Dec 4, 2019

this will require some link updates in places we don't own. @adellape do you think you know where these might be?

@ecordell There's a couple in the openshift-docs repo that I can update. Other than that, looked in the openshift/console repo and only found https://github.com/openshift/console/blob/master/frontend/packages/operator-lifecycle-manager/src/components/clusterserviceversion.tsx#L487. Were there other places that came to mind?

@openshift-ci-robot openshift-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Dec 10, 2019
@njhale
Copy link
Member Author

njhale commented Dec 10, 2019

@ecordell I removed the doc rename for now. PTAL.

@njhale
Copy link
Member Author

njhale commented Dec 12, 2019

/retest

1 similar comment
@njhale
Copy link
Member Author

njhale commented Dec 12, 2019

/retest

@exdx
Copy link
Member

exdx commented Dec 12, 2019

/lgtm

@openshift-ci-robot openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Dec 12, 2019
@openshift-ci-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: exdx, njhale

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@njhale
Copy link
Member Author

njhale commented Dec 13, 2019

/retest

retesting docs 😅

@njhale
Copy link
Member Author

njhale commented Dec 13, 2019

/retest

@openshift-merge-robot openshift-merge-robot merged commit 2864699 into operator-framework:master Dec 13, 2019
@njhale njhale deleted the design-goals branch March 31, 2020 21:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kevinrizza kevinrizza kevinrizza left review comments

@ecordell ecordell Awaiting requested review from ecordell

@jpeeler jpeeler Awaiting requested review from jpeeler

Assignees

@exdx exdx

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
7 participants
@njhale @ecordell @adellape @exdx @openshift-ci-robot @kevinrizza @openshift-merge-robot