Skip to content

missing steps in documentation #64

@andrew-g-za

Description

@andrew-g-za

I've opened this issue to see if there is something i can help with.

So far while working through the guide i've noticed small steps have been omitted (noticeably from step 5 onward).
My question is if this is intentional - i.e. left to the reader as an exercise, omitted to save space, or if its just a small oversight?

For example:

  • step 5 - did not show the necessary changes to the index.ftl template to display the 'backup' button
  • step 5 - mentions a new query - all-pages-data - but omits the changes to the SqlQueries enumeration and the database verticle loadSqlQueries method.
  • step 6 the apiGetPage method requires a new database service method fetchPageById that is not mentioned at all (along with the corresponding changes to the db-queries.properties file, SqlQueries enum etc)

Hopefully by this point in the tutorial the reader should be reasonably comfortable making the necessary changes without being show explicitly, so perhaps all that is required is a tip / note to remind the reader to make the changes on their own, rather than discovering something is missing when their IDE complains?

I'm happy to help out with some changes if you like - just let me know what sort of style to follow - full step-by-step instructions or just a reminder.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions