#docs (2018-12)
Discussions related to https://github.com/cloudposse/docs
Archive: https://archive.sweetops.com/docs/
2018-12-05
Has the deployed version of the docs been refreshed?
What ever is in master should be released on the web
We cut a release for every merge to master
Mmmm
btw, related to the docs - feel free to open issues there too
…with questions, suggestions, etc
we’ll get those addressed. we have some challenges right now with information architecture and how to organize everything
Will do
2018-12-12
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.
seen this? http://plantuml.com/deployment-diagram
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.
I like that UML is a standard language
don’t like we have to compile the images
i like that images are shareable though
what I like about the mermaid approach is it just uses a JS canvas, so no image generation required
easier for static documentation.
Yea that makes sense
@Igor Rodionov check this out
@maarten is using it here in his docs: https://airship.tf/guide/ecs_service/#application-load-balancer-alb
Home of Terraform Airship
@Erik Osterman (Cloud Posse) this is awsome
we need to create task for frontend to implement that on our docs portal
Yes will do
@maarten how did you find mermaidjs?
2018-12-13
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…
going to take a stab at adopting this
we’ll track in in 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/…
we’ve moved all troubleshooting related docs to this category:
https://docs.cloudposse.com/faq/ is now strictly for product related q & a
https://docs.cloudposse.com/design-decisions/ <– home of future design decisions
2018-12-20
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…
Great improvement @Erik Osterman (Cloud Posse)!
we have someone starting tomorrow who will help us keep the docs updated.
Even better