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

[FEATURE REQUEST] Remove unnecessary design docs. #2864

Closed
6 of 20 tasks
erzetpe opened this issue Jan 13, 2022 · 4 comments
Closed
6 of 20 tasks

[FEATURE REQUEST] Remove unnecessary design docs. #2864

erzetpe opened this issue Jan 13, 2022 · 4 comments
Assignees
Labels
area/docs Area for documentation improvement and addition

Comments

@erzetpe
Copy link
Contributor

erzetpe commented Jan 13, 2022

Is your feature request related to a problem? Please describe.
We have old design docs that can be misleading for someone using Epiphany.

Describe the solution you'd like
We want to review existing design docs and remove unnecessary ones.

Describe alternatives you've considered
None.

Additional context
None.


DoD checklist

  • Changelog
    • updated
    • not needed
  • COMPONENTS.md
    • updated
    • not needed
  • Schema
    • updated
    • not needed
  • Backport tasks
    • created
    • not needed
  • Documentation
    • added
    • updated
    • not needed
  • Feature has automated tests
  • Automated tests passed (QA pipelines)
    • apply
    • upgrade
    • backup/restore
  • Idempotency tested
  • All conversations in PR resolved
  • Solution meets requirements and is done according to design doc
  • Usage compliant with license
@erzetpe erzetpe added status/grooming-needed area/docs Area for documentation improvement and addition labels Jan 13, 2022
@rafzei rafzei self-assigned this Mar 3, 2022
@rafzei
Copy link
Contributor

rafzei commented Mar 3, 2022

@seriva , @atsikham , @to-bar, @plirglo, (and all others)

Please tell me, what do you think about the new approach for design-doc:

The design-doc we store should be related to the feature we are going to implement.
During the SPIKE, design-doc should be created.
After implementing the feature and release a new epicli version design-doc should be removed.

In the following approach, we would avoid a mess in this documentation.

If you agree, I will remove all .md's not related to the release 2.0 version (everything beside rook).

@seriva
Copy link
Collaborator

seriva commented Mar 3, 2022

@seriva , @atsikham , @to-bar, @plirglo, (and all others)

Please tell me, what do you think about the new approach for design-doc:

The design-doc we store should be related to the feature we are going to implement.
During the SPIKE, design-doc should be created.
After implementing the feature and release a new epicli version design-doc should be removed.

In the following approach, we would avoid a mess in this documentation.

If you agree, I will remove all .md's not related to the release 2.0 version (everything beside rook).

Yeah I think this is a good idea.

@to-bar
Copy link
Contributor

to-bar commented Mar 4, 2022

IMO if feature is present in source code then corresponding design-doc may be helpful for someone to get familiar with the feature (especially when the doc contains a diagram) or to find out why a decision was made.

For me standard docs are rather addressed to users (how to use, user guide) and design-docs are addressed to team members or advanced users (how it works or why that's way).

But I see one problem with keeping a design-doc as long as feature is present - it should be updated - keep in sync with implementation and later changes.

@seriva seriva closed this as completed Mar 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Area for documentation improvement and addition
Projects
None yet
Development

No branches or pull requests

5 participants