#docs (2018-12)

Discussions related to https://github.com/cloudposse/docs

Archive: https://archive.sweetops.com/docs/

2018-12-20

Erik Osterman (Cloud Posse) avatar
Erik Osterman (Cloud Posse)
Document our Semver Strategy · Issue #335 · cloudposse/docs

what it's not clear how we currently do versioning old strategy Bump patch always unless there was a “known breaking change” Bump minor anytime there was a breaking change We never bumped major…

Jan avatar

Great improvement @Erik Osterman (Cloud Posse)!

Erik Osterman (Cloud Posse) avatar
Erik Osterman (Cloud Posse)

we have someone starting tomorrow who will help us keep the docs updated.

Jan avatar

Even better

2018-12-13

Erik Osterman (Cloud Posse) avatar
Erik Osterman (Cloud Posse)
Blog | Documenting Architecture Decisions | Relevance

Context Architecture for agile projects has to be described and defined differently. Not all decisions will be made at once, nor will all of them be done whe…

Erik Osterman (Cloud Posse) avatar
Erik Osterman (Cloud Posse)

going to take a stab at adopting this

Erik Osterman (Cloud Posse) avatar
Erik Osterman (Cloud Posse)

we’ll track in in cloudposse/docs

Erik Osterman (Cloud Posse) avatar
Erik Osterman (Cloud Posse)
10:22:44 PM
Erik Osterman (Cloud Posse) avatar
Erik Osterman (Cloud Posse)
Create Design Decisions Category by osterman · Pull Request #323 · cloudposse/docs

what Start a "Design Decisions" category why Allow us to discuss big decisions in an open, collaborative (via GitHub PRs) and transparent manner references https://github.com/npryce/

Erik Osterman (Cloud Posse) avatar
Erik Osterman (Cloud Posse)

@Jan

fiesta_parrot1
Erik Osterman (Cloud Posse) avatar
Erik Osterman (Cloud Posse)

we’ve moved all troubleshooting related docs to this category:

Erik Osterman (Cloud Posse) avatar
Erik Osterman (Cloud Posse)

https://docs.cloudposse.com/faq/ is now strictly for product related q & a

Erik Osterman (Cloud Posse) avatar
Erik Osterman (Cloud Posse)

https://docs.cloudposse.com/design-decisions/ <– home of future design decisions

2018-12-12

Erik Osterman (Cloud Posse) avatar
Erik Osterman (Cloud Posse)
Online FlowChart & Diagrams Editor - Mermaid Live Editor attachment image

Simplify documentation and avoid heavy tools. Open source Visio Alternative. Commonly used for explaining your code! Mermaid is a simple markdown-like script language for generating charts from text via javascript.

Jan avatar
Deployment Diagram syntax and features

PlantUML deployment diagram syntax: Deployment diagrams are not fully supported within PlantUML. This is a draft version of the language can be subject to changes.

Erik Osterman (Cloud Posse) avatar
Erik Osterman (Cloud Posse)

I like that UML is a standard language

Erik Osterman (Cloud Posse) avatar
Erik Osterman (Cloud Posse)

don’t like we have to compile the images

Erik Osterman (Cloud Posse) avatar
Erik Osterman (Cloud Posse)

i like that images are shareable though

Erik Osterman (Cloud Posse) avatar
Erik Osterman (Cloud Posse)

Erik Osterman (Cloud Posse) avatar
Erik Osterman (Cloud Posse)

what I like about the mermaid approach is it just uses a JS canvas, so no image generation required

Erik Osterman (Cloud Posse) avatar
Erik Osterman (Cloud Posse)

easier for static documentation.

Jan avatar

Yea that makes sense

Erik Osterman (Cloud Posse) avatar
Erik Osterman (Cloud Posse)

@Igor Rodionov check this out

Erik Osterman (Cloud Posse) avatar
Erik Osterman (Cloud Posse)
.. ECS made easy

Home of Terraform Airship

Igor Rodionov avatar
Igor Rodionov

@Erik Osterman (Cloud Posse) this is awsome

Igor Rodionov avatar
Igor Rodionov

we need to create task for frontend to implement that on our docs portal

Erik Osterman (Cloud Posse) avatar
Erik Osterman (Cloud Posse)

Yes will do

Erik Osterman (Cloud Posse) avatar
Erik Osterman (Cloud Posse)

@maarten how did you find mermaidjs?

2018-12-05

Jan avatar

Has the deployed version of the docs been refreshed?

Erik Osterman (Cloud Posse) avatar
Erik Osterman (Cloud Posse)

What ever is in master should be released on the web

Erik Osterman (Cloud Posse) avatar
Erik Osterman (Cloud Posse)

We cut a release for every merge to master

Jan avatar

Mmmm

Erik Osterman (Cloud Posse) avatar
Erik Osterman (Cloud Posse)

btw, related to the docs - feel free to open issues there too

Erik Osterman (Cloud Posse) avatar
Erik Osterman (Cloud Posse)

…with questions, suggestions, etc

Erik Osterman (Cloud Posse) avatar
Erik Osterman (Cloud Posse)

we’ll get those addressed. we have some challenges right now with information architecture and how to organize everything

Jan avatar

Will do

    keyboard_arrow_up