home.social

#gitworkflows — Public Fediverse posts

Live and recent posts from across the Fediverse tagged #gitworkflows, aggregated by home.social.

fetched live
  1. #TechnicalWriting #DocsAsCode #Markdown #Git #SoftwareDocumentation #GitWorkflows #SoftwareDevelopment: "When you use a docs as code workflow, you need to codify your docs processes and instantiate them in your Git workflow. So you not only need to define the following:

    - When to publish doc updates
    - How to release doc updates
    - How to coordinate a docs release with a product release

    You also need to define Git best practices for your team about how to manage those, such as:

    - Whether to use release branches, or merge pull requests frequently but publishing infrequently.
    - Whether to use Git rebase or Git merge to maintain Git history in a given branch.
    - Whether and how to use feature branches and pull requests.
    - Whether to squash merge pull requests to main.

    Even if you manage to define best practices that your team is committed to following, there isn’t a way to force your documentation contributors to adhere to all of these best practices. Due to the lack of enforcement of these best practices, you can easily end up in a situation where writers follow slightly different practices based on what their tools make easy to do."

    thisisimportant.net/posts/docs

  2. #TechnicalWriting #DocsAsCode #Markdown #Git #SoftwareDocumentation #GitWorkflows #SoftwareDevelopment: "When you use a docs as code workflow, you need to codify your docs processes and instantiate them in your Git workflow. So you not only need to define the following:

    - When to publish doc updates
    - How to release doc updates
    - How to coordinate a docs release with a product release

    You also need to define Git best practices for your team about how to manage those, such as:

    - Whether to use release branches, or merge pull requests frequently but publishing infrequently.
    - Whether to use Git rebase or Git merge to maintain Git history in a given branch.
    - Whether and how to use feature branches and pull requests.
    - Whether to squash merge pull requests to main.

    Even if you manage to define best practices that your team is committed to following, there isn’t a way to force your documentation contributors to adhere to all of these best practices. Due to the lack of enforcement of these best practices, you can easily end up in a situation where writers follow slightly different practices based on what their tools make easy to do."

    thisisimportant.net/posts/docs