search

mendix / docs

Mendix documentation repository
https://docs.mendix.com
Creative Commons Attribution 4.0 International
137 stars 708 forks source link

Atlas UI Wizard Form Page Template Documentation proposal #6084

Open Oscar-21 opened 1 year ago

Oscar-21 commented 1 year ago

Proposal:

I would like to contribute some documentation about the Atlas UI page template called Wizard Form.

Possible destinations for the documentation

  1. As a how to article
  2. Added to a specific section in the documentation. I would ask for guidance on this one.
  3. (Not sure how useful this last suggestion would be) If we added one of the previous suggestions, I think we could add a link to the how-to on the documentation property on the Wizard Form Page Template as a separate commit into the Atlas UI repo.

Motivation for the Proposal:

This page template allows you to create a wizard form that divides a single form into separate pages of inputs. It takes the user through a task by using an ordered series of pages.

There is some interesting default behavior in this template, for example: by default the first page is marked as visited and the second page is marked as active by referencing css classes called wizard-step-visted and wizard-step-active, respectively.

The template is well done and fairly easy to use, but if I had not gone through this course and just selected the page template I am not sure I would have known about these classes or the default behavior, nor that I should create multiple wizard pages, one for each step, rather than use one wizard page. (This may have been a design decision rather than a requirement). I went and looked for some documentation on this page template, and when I could not find one, thought it may be a good chance to contribute to the Mendix documentation.

If this is something that the team thinks would be useful addition to the documentation, I would be happy to work on creating a contribution for it.

Adam-Dupaski commented 1 year ago

@Oscar-21 thanks for the suggestions and the offer to write some documentation.

@ConnorLand what do you think?

ConnorLand commented 9 months ago

Hello @Oscar-21 ,

Thank you for your proposal. Mendix strives to offer templates that are self-explanatory out of the box. However, you've found some key parts of the Wizard Form template that work a bit differently than how users might expect.

I am chatting with our Front End and Design departments about where documentation for this template might fit best. For now, could you please draft a basic set of instructions summarizing how you yourself figured out how to best use this template? Just comment in this GH issue when you've made a basic draft and I will help with editing and publishing it -- perhaps as a doc on our site, perhaps as a READ.me file in the Atlas Resource GitHub repo.

Thank you for contributing to the documentation,

Connor

ConnorLand commented 9 months ago

I've been in contact with Design and they will host your instructions in an Atlas repo for now. In the future, they plan on documenting all of their templates more thoroughly. When that occurs they will use your draft for Wizard Form as the starting point for that template's doc page.

But for now just let me know when you have something and I'll help you with a pull request to their Atlas GH repo. Thanks Oscar.

Oscar-21 commented 8 months ago

Thanks I'll submit a PR soon.