Skip to content
This repository has been archived by the owner on Oct 4, 2021. It is now read-only.

How Helix Works, initial version #51

Merged
merged 4 commits into from
May 27, 2019

Conversation

bdelacretaz
Copy link
Contributor

Please review the diagram and explanations, and also whether we're ready to expose that information on the public https://www.project-helix.io/ website.

I used https://monodraw.helftone.com/ to create the diagram but its ASCII output is not easy to modify if you don't have the source .monopic file so it's not really better than other diagramming tools which all have their own format.

Maybe we should use GraphViz (as an extension in I/O runtime) to generate diagrams on the fly from Markdown file sections.

Copy link

@filmaj filmaj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job Bertrand! Thanks for putting this together. Excellent first step, and I left comments. Happy to help push this forward. This is exactly the kind of document I was looking for early on when ramping up on helix!!!

doc/getting-started/how-helix-works.md Outdated Show resolved Hide resolved
doc/getting-started/how-helix-works.md Outdated Show resolved Hide resolved
doc/getting-started/how-helix-works.md Outdated Show resolved Hide resolved
supplied in the GitHub source repository.

Updates to these components are atomic, and the Helix Strains let users define staged variants of their content, to have
full control on the publishing process and allow for intermediate reviews before publishing content.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure we should advertise this 'publishing process' at this point because I don't think we've converged on a recommended practice for it yet. If we have and I just don't know it, great, but then we should document it 😄

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense, removing this!

@bdelacretaz
Copy link
Contributor Author

Thank you very much @filmaj for your feedback! I have redone the diagram and updated the text as per your comments.

GraphViz diagram...

I did the diagram with GraphViz and I like the text-based process and the result is informative IMHO and not too bad visually.

We'll probably redo of of those diagrams "by hand" eventually to make them look nicer, but in this development phase I think using text-based diagrams gives us a much better chance for them to stay in sync with reality, even if they don't look as good visually as we'll ultimately want.

Copy link

@filmaj filmaj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job on the redone diagram! Incredible work. Ship it! :shipit:

@bdelacretaz
Copy link
Contributor Author

Thank you @filmaj - I don't seem to have karma to merge, not sure if I need to ping someone to do that or how that works.

@filmaj
Copy link

filmaj commented May 24, 2019

I can merge but I don't want to do it without someone from the core project team approving.

@stefan-guggisberg stefan-guggisberg merged commit 777d497 into adobe:master May 27, 2019
@stefan-guggisberg
Copy link
Contributor

Excellent, thanks @bdelacretaz. Merged.

@stefan-guggisberg
Copy link
Contributor

related: adobe/helix-cli#711

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants