Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Create a reconversion guide #8380

Merged
merged 24 commits into from
Nov 5, 2020
Merged

Docs: Create a reconversion guide #8380

merged 24 commits into from
Nov 5, 2020

Conversation

jodator
Copy link
Contributor

@jodator jodator commented Oct 30, 2020

Suggested merge commit message (convention)

Docs (engine): Create a reconversion guide. Closes #8174.


Additional information

  • I've rewritten the sample several times and I think that the current content example is useful.
  • The general idea is to have two parts of the guide:
    1. introduction to reconversion and reconversion concepts
    2. an example with the most relevant code is explained (the rest is in the full source code)

TODO:

  • The initial section about the reconversion needs expanding.
  • The example implementation needs closure with a full code.

@jodator jodator requested a review from Reinmar November 2, 2020 08:08
@jodator jodator marked this pull request as ready for review November 2, 2020 08:08
Copy link
Contributor

@godai78 godai78 left a comment

Choose a reason for hiding this comment

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

I hereby approve this deep-dive guide to be worthy enough to join the great documents family. Providing the code is provided at the end.

@jodator
Copy link
Contributor Author

jodator commented Nov 4, 2020

OK, I've pimped-out the demo slightly (UI button to insert a card).
The code was added at the end and code examples were updated accordingly.

@AnnaTomanek AnnaTomanek self-requested a review November 4, 2020 11:38
@AnnaTomanek
Copy link
Contributor

I fixed a few things here and there, including a leftover ComplexInfoBox model element and some paragrahps 😉  Good job overall!

Things that we could still consider adding (although they can also be added as a later update):

  • Replacing the yummy lorem ipsum with some real text (@godai78, any ideas?)
  • Adding some "Next steps" section (or another form) with links to some other conversion guides (if it still makes sense) - our users do not always read the docs like a book, one after another, they will land here e.g. directly from the blog post.
  • Adding the "select all" or whatever it is called UI element to the card that would allow you to select it and delete - now it's a bit counter-intuitive that you can add it and it's not really clear what you need to click to select it.

Copy link
Contributor

@AnnaTomanek AnnaTomanek left a comment

Choose a reason for hiding this comment

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

Looks great - thanks for the tutorial, @jodator, and kudos for the demo content, @godai78 👏

@AnnaTomanek AnnaTomanek merged commit daedd3c into stable Nov 5, 2020
@AnnaTomanek AnnaTomanek deleted the i/8174 branch November 5, 2020 11:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants