Skip to content

Rework First steps methodology#77

Open
edison23 wants to merge 222 commits intomasterfrom
improve/methodology-first-steps
Open

Rework First steps methodology#77
edison23 wants to merge 222 commits intomasterfrom
improve/methodology-first-steps

Conversation

@edison23
Copy link
Contributor

@edison23 edison23 commented Jan 7, 2026

This PR presents the completely reworked First steps methodology. My goal was to make the guide work as a standalone series of articles (modules) that are independent on the video presentations in the original MID-301 First steps training (unlike the original 6-article First steps methodology we currently have in the Documentation). One of the reasons is that I believe it may be for many users more comfortable and beneficial to follow a textual guide rather than watching videos because following text guides supports the learning process better, I think. I used the original training as a foundation for the content in the First steps guide I have written.

I would hereby like to kindly ask for a review of my work here. I would be grateful for validation (or rejection for that matter) of the learning flow, the value for learners, and for pieces of advice on what can possibly be improved in that regard, as I find the flow and learning value the most important aspects of such a guide. However, I will be happy to hear any remarks, of course.

I am assigning this to you, @dejavix , since the original course is your work, but please feel free to delegate as you see fit; I am aware it is a lot of content and the time invenstment is substantial. Obviously, I count on the fact the review may take some time, that is completely fine.
I am tagging for visibility @licehammer and @jirihuf .

edison23 added 30 commits March 7, 2025 11:09
…-first-steps to sync it with latest master changes
…change heading structure for clarity; describe mapping naming policices
Because we decided they need to be versioned and thus kept in midpoint/reference. The deleted stubs were worthless in their
current state and, thus, could be safely deleted as such.
We don't have a suitable tutorials yet as I had to put the work on GUI guides section on hold to create it in the versioned docs
section.
@edison23 edison23 requested a review from dejavix January 7, 2026 13:03
Consequence of Evolveum/midpoint/4079bef4db1039239c468722b0ff1628b6f093e6
Which was possible thanks to restructuring the article so that anchoring to that heading is not needed anymore.
The redirects have been decided based on the content similarity. Sometimes (e.g., in the case of audience), the content is not
under the 1st heading in the target page, and other times, the old big article was split into multiple articles or even sections
(Assessment). In such a case, the redirect leads to the first section.
Newly using the diagram from the 1st3ps methodology training slides to help people see the connection between the training and the tutorial in the Docs.
Change the article title to include the "kick-off" keyword in order to help people see the connection between the training and the tutorial in the Docs.
- Methodology is the theoretical part, similar to how the original 1st3ps methodology was designed
- Training is the practical part showcasing the theory on concrete applications (HRIS and AD/LDAP), closely following the original MID-301 course

The two are not entirely independent but they target different audience (business vs.
technical persona) and are of a different content type (conceptual talk vs. tutorials)
- I have decided to retract renaming the folder of the methodology section of 1st3ps because I have realized it would mean high amount of link updates across the whole Documentation (including all branches in the `midpoint` repo). The ROI of such a change does not seem reasonable to me. The display name remains, link path stays the same. The training section continues to be the new `first-steps-training`.
- I have updated all xref paths in the methodology and training according to the new structure.
- It is not "a guide" as a whole now since it has two parts -> adjusted wording of intro articles accordingly
- Fixed a few typos (thx to @dejavix)
This is particularly important for the section overview table used in the `first-steps-training/index.adoc`.
@edison23
Copy link
Contributor Author

@licehammer , @dejavix : Since our review session, I have implemented what we have agreen on:

  • Split the methodology and training parts
    • At first, I renamed also the methodology directory to make the naming consistent and include "methodology" in it. Afterwards, I have decided to take that decision back because it would mean updating very many xref paths throughout the whole Documentation which does not seem worth it to me. That is why there are many renamed files in 47b542d and then in d863817 which takes the rename back.
  • Use the iterative approch schema from vix's 1st3ps slides
  • Use the word "kick-off" in the deployment plan module.
  • Aside implementing our agreements, I have removed unused images (mostly files I have added, used at some point, and then replaced them with something else), and changed the overview lists ({% children %} to tables for better UX.

The commit directly related to our discussion last week:

  • 47d8120 (replace the diagram)
  • 1ffb9cb (add the kick-off term)
  • 47b542d (split; includes the rename which I undid in the following commit)
  • 863817 (undo the methodology dir rename)
  • 1f81167 (address typos found by vix and adjust phrasing to reflect the split - I mostly called the whole thing a "guide" before the split)

Please kindly review the adjustments and let me know if they are in agreement with the vision you have for First steps.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments