Update handbook to Edit through the Web IDE by default
Why is this change being made?
Our objective is to streamline and align the editing actions for both the public and private handbooks while promoting the use of the Web IDE as the default method for editing handbook pages. To achieve this, we will be implementing changes to the language used for contributions and removing the blob viewer URL.
The benefits of these updates are twofold. First, by aligning the editing actions for public and private handbooks, we create a consistent experience across our documentation, ensuring that contributors follow the same processes regardless of the handbook they are working on. This alignment simplifies the overall editing workflow and improves efficiency.
Secondly, by making the Web IDE the default pattern for editing handbook pages, we enhance the user experience and accessibility. The Web IDE provides a convenient and user-friendly interface for editing, with features tailored specifically for code and documentation. Utilizing the Web IDE as the default method encourages collaboration and simplifies the editing process for all contributors, regardless of their technical background.
Overall, these updates not only harmonize the editing actions between the public and private handbooks but also leverage the benefits of the Web IDE to enhance the editing experience, resulting in increased efficiency and improved accessibility for contributors.
Before | After |
---|---|
Author Checklist
-
Provided a concise title for this Merge Request (MR) -
Added a description to this MR explaining the reasons for the proposed change, per say why, not just what - Copy/paste the Slack conversation to document it for later, or upload screenshots. Verify that no confidential data is added, and the content is SAFE
-
Assign reviewers for this MR to the correct Directly Responsible Individual/s (DRI) - If the DRI for the page/s being updated isn’t immediately clear, then assign it to one of the people listed in the
Maintained by
section on the page being edited - If your manager does not have merge rights, please ask someone to merge it AFTER it has been approved by your manager in #mr-buddies
- The when to get approval handbook section explains the workflow in more detail
- If the DRI for the page/s being updated isn’t immediately clear, then assign it to one of the people listed in the
-
If the changes affect team members, or warrant an announcement in another way, please consider posting an update in #whats-happening-at-gitlab linking to this MR - If this is a change that directly impacts the majority of global team members, it should be a candidate for #company-fyi. Please work with internal communications and check the handbook for examples.