[
https://issues.apache.org/jira/browse/IGNITE-12968?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17198342#comment-17198342
]
Denis A. Magda commented on IGNITE-12968:
-----------------------------------------
[~mmuzaf], there was nothing wrong with your documentation. Quite opposite, you
create a very-well written page with plenty of details, and it was easy for me
to optimize it. What I did next is more of a content simplification and logical
flow.
For instance, you see that I rearranged the flow of the sections (Overview ->
Config -> Creation -> Restore -> Consistency -> Limitations). The "Overview"
should be short but clear, so that new readers can quickly comprehend the
feature and withing the next 10-20 seconds figure out if that's what they were
looking for. Once the buy the feature, let's quickly show them how to configure
and use it, thus Config -> Creation -> Restore goes next (the readers are
developers and like to read concise code, thus I would put it to the top of the
page as soon as possible). Finally, Consistency and Limitations are ideally
suited for the end of the page. By getting to these sections, the readers
should already be convinced about the feature and can learn the last bits.
If you're interested in learning and practicing more about technical writing, I
can share some resources with you and keep working with you on your future
contributions to docs. I've been doing technical writing for the last 5 years
(docs, blogs, tutorials) but when my content is reviewed by a professional
technical writer/editor I always get a plenty of edits :) That doesn't
discourage me but motivates learn more.
> Create cluster snapshot documentation pages
> -------------------------------------------
>
> Key: IGNITE-12968
> URL: https://issues.apache.org/jira/browse/IGNITE-12968
> Project: Ignite
> Issue Type: Task
> Components: documentation
> Reporter: Maxim Muzafarov
> Assignee: Maxim Muzafarov
> Priority: Blocker
> Labels: iep-43, important
> Fix For: 2.9
>
> Time Spent: 6h 40m
> Remaining Estimate: 0h
>
> Add the following to the Apache Ignite documentation:
> 1. How to create a cluster snapshot (describe API, limitations)
> 2. How to configure a destination directory
> 3. Manual steps for a snapshot restore
> 4. Examples
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
