design-template: Fix typo

Change-Id: Ie8fa5e930f7107f473cb27915ba0f2cf2e66ff82
Signed-off-by: Peter Delevoryas <peter@pjd.dev>

Add design doc about optionality

Many patches these days ignore the concept of features being optional,
and measuring impact to the project. This documentation attempts to
close that gap, by having

Add design doc about optionality

Many patches these days ignore the concept of features being optional,
and measuring impact to the project. This documentation attempts to
close that gap, by having some explicitly defined language in the
architecture that developers can reference in their commit messages, and
maintainers can point to for general guidance on option flags.

Signed-off-by: Ed Tanous <edtanous@google.com>
Change-Id: Id1ab8f1765110f58f22670db18db7ed226da6b57

show more ...

prettier: re-format

Prettier is enabled in openbmc-build-scripts on Markdown, JSON, and YAML
files to have consistent formatting for these file types. Re-run the
formatter on the whole repository.

prettier: re-format

Prettier is enabled in openbmc-build-scripts on Markdown, JSON, and YAML
files to have consistent formatting for these file types. Re-run the
formatter on the whole repository.

Change-Id: I35ec9c19ae581e4dd00b515c1bba3a9c1862eeb1
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>

show more ...

design-template: Design proposals are argumentative essays.

State this explicitly in the guidelines. The Grammarly blog post is
excellent and well worth the read.

Change-Id: I06ef86fab5601e3ad0e8b5

design-template: Design proposals are argumentative essays.

State this explicitly in the guidelines. The Grammarly blog post is
excellent and well worth the read.

Change-Id: I06ef86fab5601e3ad0e8b5b2fefd85aec25a6015
Signed-off-by: Andrew Jeffery <andrew@aj.id.au>

show more ...

design-template: Organise guidelines

Add some sub-headers and rename the section to "Document Guidelines".
Do the rename because the section is guiding you on when/how to write
the document, not how

design-template: Organise guidelines

Add some sub-headers and rename the section to "Document Guidelines".
Do the rename because the section is guiding you on when/how to write
the document, not how to design your thingo.

Change-Id: Iddf5540e80d5af00c9ef49bd1f7077cd4dfdddaa
Signed-off-by: Andrew Jeffery <andrew@aj.id.au>

show more ...

Update organizational section with maintainer cc

Lots of designs get submitted that seem to omit the maintainers from the
CC list, as well as designs that focus on only one part of the design
(somet

Update organizational section with maintainer cc

Lots of designs get submitted that seem to omit the maintainers from the
CC list, as well as designs that focus on only one part of the design
(sometimes dbus, sometimes redfish, sometimes IPMI) without considering
the whole system.

This commit adds a section to the design template for "repos that are
expected to be modified", so that we can make sure the required
reviewers are present on the design. This also helps as a hint to
reviewers that they need to account for their whole design
(hw->dbus->user interface), not just a single piece, like dbus->user
interface or hw->dbus.

Signed-off-by: Ed Tanous <edtanous@google.com>
Change-Id: I74d34dafe7da0c83484df7afa96d3aef12efcc27

show more ...

design-template: remove Primary Assignee

Nowhere do we document what a "Primary Assignee" is and I don't know
what it means. Drop it from the template.

Signed-off-by: Patrick Williams <patrick@stw

design-template: remove Primary Assignee

Nowhere do we document what a "Primary Assignee" is and I don't know
what it means. Drop it from the template.

Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: Ib107f90592965cf07982b5c576804938952fb256

show more ...

design-template: fix 'nick' spelling

'Nick' was spelled as 'Nic'. Fix it and expand to 'Nickname' for
clarity.

Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I354c523e0bf2a2dcf9bb6

design-template: fix 'nick' spelling

'Nick' was spelled as 'Nic'. Fix it and expand to 'Nickname' for
clarity.

Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I354c523e0bf2a2dcf9bb6d57cc246bec438ccb64

show more ...

Add organizational section to the template

It was commented several times that we could significantly decrease our
time to repo creation if we called out in the design doc, whether or not
this featu

Add organizational section to the template

It was commented several times that we could significantly decrease our
time to repo creation if we called out in the design doc, whether or not
this feature requires a new repository, and who will maintain that
repository. This commit adds those questions to the design template to
that effect.

Signed-off-by: Ed Tanous <edtanous@google.com>
Change-Id: I6972494d12d91b897780eb0469d7a7188472eca4

show more ...

Replace IRC with Discord

Discord has more users. IRC traffic has ground to a halt.

No real objection to
https://lists.ozlabs.org/pipermail/openbmc/2020-November/023984.html

Removed IRC from the RE

Replace IRC with Discord

Discord has more users. IRC traffic has ground to a halt.

No real objection to
https://lists.ozlabs.org/pipermail/openbmc/2020-November/023984.html

Removed IRC from the README and replaced IRC in other places.

Change-Id: Iae40d6228f18ee10b4df34003a3d4b49ec5c2cc7
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>

show more ...

Clarify Created Date

Has been some confusion about the date format, added the
Month D, Yr format e.g. June 17, 2020. Allow for abbreviated
month.

Removed a "revisions in will be tracked in Gerrit"

Clarify Created Date

Has been some confusion about the date format, added the
Month D, Yr format e.g. June 17, 2020. Allow for abbreviated
month.

Removed a "revisions in will be tracked in Gerrit" since didn't
add value.

Change-Id: I27faef84c1c8b6cb07fc1114bd457b9ea0504313
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>

show more ...

design: Add "design" topic to gerrit reviews

This allows a query like this to be run to find all open design docs:
https://gerrit.openbmc-project.xyz/#/q/topic:design+status:open

This allows easy s

design: Add "design" topic to gerrit reviews

This allows a query like this to be run to find all open design docs:
https://gerrit.openbmc-project.xyz/#/q/topic:design+status:open

This allows easy searching for design reviews in gerrit.

Change-Id: Ia9dbdf0b762af7713e2cbd647ca45a8c5a609424
Signed-off-by: Andrew Geissler <geissonator@yahoo.com>

show more ...

Put Author, Assignee, Created on newline

These header fields are easier to read if they are on
separate lines.

Tested: Copied into https://jbt.github.io/markdown-editor
Change-Id: Ibcd204f21d40c99c

Put Author, Assignee, Created on newline

These header fields are easier to read if they are on
separate lines.

Tested: Copied into https://jbt.github.io/markdown-editor
Change-Id: Ibcd204f21d40c99ccce14cc97947c212ccc337b5
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>

show more ...

design-template: reduce heading depth

Reduce heading depth from the start to reduce depth of sub-headings in
detailed design. As the designs are meant to stand alone, they do not
need an explicit i

design-template: reduce heading depth

Reduce heading depth from the start to reduce depth of sub-headings in
detailed design. As the designs are meant to stand alone, they do not
need an explicit initial depth of 3.

Change-Id: Ib037c2da81962d7b5bee8dc01916e1269e189e5e
Signed-off-by: Patrick Venture <venture@google.com>

show more ...

OpenBMC Design Template

This is a proposed design template for new OpenBMC features. It is
heavily influenced by the OpenStack, PEP and Google design
documents.

Change-Id: I80cd52873e2692a4ffed6589

OpenBMC Design Template

This is a proposed design template for new OpenBMC features. It is
heavily influenced by the OpenStack, PEP and Google design
documents.

Change-Id: I80cd52873e2692a4ffed6589507c46b5d99f47fb
Signed-off-by: Kurt Taylor <kurt.r.taylor@gmail.com>

show more ...