Motivation/Why?

• We have one design doc merged under a directory.
• We are going to merge a new one (#2) under another directory.
• Both design docs are related to satellite, however:
  • The one to merge isn't currently in the satellite directory as the first one.
  • The one to merge is also related to Edge services for supporting more S3 endpoints.

What needs to be done?

• Determine a directory structure or keep the documents in the root of the repository.

Acceptance Criteria

• In the case that we decide to have a directory structure:
  • Define if there is one level or sub-levels.
  • Define how the directory structure is created, for example per system, area, etc. The structure should be clear so future design doc writers know where to add their document (in an existing directory or creating one following the defined structure)
• Decide where the old design docs should be kept. Unblock #4
• Document in the README about the directory structure, or in the case of keeping the documents in the root, explicitly mention it.

Motivation/Why?

• We want to have all the design documents in one place to make it easy for everybody (employees, community members, contributors, etc.) to find them.

What needs to be done?

• Move the blueprint documents stored in the storj repository to this one.

Acceptance Criteria

• Create a PR with all the documents that are in the storj repository.
• Create a commit to delete all the documents of the storj repository.

Blocked by #3

Motivation/Why?

We want a single to find all the relevant information about the design of all the systems related to Storj.

What needs to be done?

• Take all the blueprint documents in storj repository that are still applicable (code and logic that remains) and add them to the root of this repository.
• Rename those documents to prefix them with the initial commit date with the format specified in the conventions present in the README.
• Add a frontmatter with the required fields specified in the conventions present in the README.
• Documents that aren't applicable, place them in a folder in the root named archived.

Acceptance criteria

• Add all the blueprint documents in storj repository to this repository.
• Once they are in, delete those documents from the storj repository.

Motivation/Why?

• We have an internal document that defines what a design document should contain and how it should be structured.

What needs to be done?

• Create a template so people can copy and paste for filling the information when they have to create a new design document.

Acceptance Criteria

• Create the template according to our internal document about writing a good design document https://storjlabs.atlassian.net/wiki/spaces/delivery/pages/2548137985/Design+Doc+Process+Proposal+2023