search

shorebirdtech / docs

The shorebird docs site
https://docs.shorebird.dev
MIT License
9 stars 21 forks source link

docs: adding When to release or patch section #270

Closed erickzanardo closed 1 month ago

erickzanardo commented 1 month ago

Status

READY

Description

Adds some docs under the Code push section about when to choose for a release or when to choose a patch.

Open to suggestions on additions, removals, moving to a different section, etc.

Fixes #236

erickzanardo commented 1 month ago

I wonder if this should be added to FAQs instead of being it's own section. I think we could probably condense this quite a bit into a single FAQ:

Question: When should I create a patch? Answer: Generally, you should create patches when fixing bugs that DO NOT contain native changes or asset changes. For all other changes, you should likely create a new release. If distributing through stores, refer to store policies for additional guidelines.

@felangel that crossed my mind, but I feared that it would be lost among the lost list of the FAQ items that we currently have.

About the condensing part part, sounds good, I have this tendency of getting wordy sometimes 🙃

felangel commented 1 month ago

I wonder if this should be added to FAQs instead of being it's own section. I think we could probably condense this quite a bit into a single FAQ: Question: When should I create a patch? Answer: Generally, you should create patches when fixing bugs that DO NOT contain native changes or asset changes. For all other changes, you should likely create a new release. If distributing through stores, refer to store policies for additional guidelines.

@felangel that crossed my mind, but I feared that it would be lost among the lost list of the FAQ items that we currently have.

About the condensing part part, sounds good, I have this tendency of getting wordy sometimes 🙃

I just think that this is a frequently asked question so it belongs in the FAQs. We have search built into our docs so I'm not worried about folks finding it 🤷

bryanoltman commented 1 month ago

It might also work as a subsection of "concepts" where we explain patches vs releases?

felangel commented 1 month ago

It might also work as a subsection of "concepts" where we explain patches vs releases?

Yeah I would probably add this as an FAQ and link to it from the concepts sections on releases and patches.

erickzanardo commented 1 month ago

It might also work as a subsection of "concepts" where we explain patches vs releases?

Yeah I would probably add this as an FAQ and link to it from the concepts sections on releases and patches.

Roger Roger