<!--IssueSummary start--> <details> <summary> Everyone can contribute. [Help move this issue forward](https://handbook.gitlab.com/handbook/marketing/developer-relations/contributor-success/community-contributors-workflows/#contributor-links) while earning points, leveling up and collecting rewards. </summary> - [Close this issue](https://contributors.gitlab.com/manage-issue?action=close&projectId=278964&issueIid=251204) </details> <!--IssueSummary end--> <!-- The first section "Release notes" is required if you want to have your release post blog MR auto generated. Currently in BETA, details on the **release post item generator** can be found in the handbook: https://about.gitlab.com/handbook/marketing/blog/release-posts/#release-post-item-generator and this video: https://www.youtube.com/watch?v=rfn9ebgTwKg. The next four sections: "Problem to solve", "Intended users", "User experience goal", and "Proposal", are strongly recommended in your first draft, while the rest of the sections can be filled out during the problem validation or breakdown phase. However, keep in mind that providing complete and relevant information early helps our product team validate the problem and start working on a solution. --> ### Release notes <!-- What is the problem and solution you're proposing? This content sets the overall vision for the feature and serves as the release notes that will populate in various places, including the [release post blog](https://about.gitlab.com/releases/categories/releases/) and [Gitlab project releases](https://gitlab.com/gitlab-org/gitlab/-/releases). " --> - Problem: ~"org-mode" issues that require modification of rendering behavior cannot progress - Proposal: Add first-class support for org mode markup by rendering with [org-ruby](https://github.com/wallyqs/org-ruby) instead of [github-markup](https://github.com/github/markup) . ### Problem to solve <!-- What problem do we solve? Try to define the who/what/why of the opportunity as a user story. For example, "As a (who), I want (what), so I can (why/value)." --> Many of the ~"org-mode" issues require direct modification of current rendering behavior. See #14290, #25056, #32207, and #23170, for some examples. This poses a problem, because while gitlab does depend on [org-ruby](https://github.com/wallyqs/org-ruby), org-ruby machinery is never invoked directly. Instead, org-mode files go through [github-markup](https://github.com/github/markup) via [other_markup.rb](https://gitlab.com/gitlab-org/gitlab-foss/-/blob/80d252c8e25dc88023e750cf2a22be6186cfd6aa/lib/gitlab/other_markup.rb), according to https://gitlab.com/gitlab-org/gitlab/-/issues/15405#note_214809778. We could add fixes to [github-markup](https://github.com/github/markup) and bump the version here to fix bugs, but this support strategy doesn't work for proposals such as #23849, which suggest we extend org mode with existing GFM features like PlantUML / Mermaid graphs. ### Proposal <!-- How are we going to solve the problem? Try to include the user journey! https://about.gitlab.com/handbook/journeys/#user-journey --> For any of these issues to progress, org mode markup must have first-class support, in the same way that asciidoc was given. We must add special support for org mode via its own module, with its own `self.render` method. Since the [org-ruby](https://github.com/wallyqs/org-ruby) gem is already a dependency for gitlab, adding support is as easy as creating an `Orgmode::Parser` object that is roughly equivalent to how [github-markup already handles things](https://github.com/github/markup/blob/cd01f9ec87c86ce5a7c70188a74ef40fc4669c5b/lib/github/markups.rb#L13-L18). ### Further details <!-- Include use cases, benefits, goals, or any other details that will help us understand the problem better. --> This proposal would be the first stepping stone to **real** support for org mode markup in gitlab. Once implemented, proposals such as #23849 that hope to bring gfm / asciidoc features over to org-mode could actually see some more action. #### Implementation Details I'd like to add some characterizing info here about implementation, so this feature might be easier to deliver as a community contribution. As I mentioned earlier, the scope of this issue is **only** to get a setup that works similarly to the existing functionality. Currently, we use [github-markup](https://github.com/github/markup/blob/cd01f9ec87c86ce5a7c70188a74ef40fc4669c5b/lib/github/markups.rb#L13-L18) to render org mode markup, which renders the incoming `content` with the following: ```ruby Orgmode::Parser.new(content, { :allow_include_files => false, :skip_syntax_highlight => true }).to_html ``` So, maybe we should have a `/lib/gitlab/org_mode.rb` file with something like the following: ```ruby module Gitlab # Parser/renderer for org mode markup. module Orgmode # Public: Converts the provided markup into HTML. # # input - the source text in a markup format # def self.render(file_name, input, context) html = Orgmode::Parser.new(content, { :allow_include_files => false, :skip_syntax_highlight => true }).to_html .force_encoding(input.encoding) context[:pipeline] ||= :markup html = Banzai.render(html, context) html.html_safe end end end ``` (I'm not a ruby programmer, so forgive me if I've made any dumb mistakes here) Aside from this, which is the meat of the main logic, there would likely need to be other changes made that support this, including but not necessarily limited to: - [Add `.org` extension to wiki contexts in markup helper spec](https://gitlab.com/gitlab-org/gitlab/-/blob/b8bfd637eebcf1d13d74e16fbfcb4c60d8064026/spec/helpers/markup_helper_spec.rb#L333-362) - [Add `.org` extension to markup contexts in markup helper spec](https://gitlab.com/gitlab-org/gitlab/-/blob/b8bfd637eebcf1d13d74e16fbfcb4c60d8064026/spec/helpers/markup_helper_spec.rb#L414-475) - [Implement `orgmode?` and `orgmode_unsafe` functions in markup helper spec](https://gitlab.com/gitlab-org/gitlab/-/blob/b8bfd637eebcf1d13d74e16fbfcb4c60d8064026/app/helpers/markup_helper.rb) - [Add `orgmode_unsafe` call to `markup_unsafe` function in markup helper](https://gitlab.com/gitlab-org/gitlab/-/blob/b8bfd637eebcf1d13d74e16fbfcb4c60d8064026/app/helpers/markup_helper.rb#L143-153) While these last few steps aren't *necessary* for a minimum viable MR, these would be what you'd need to do to support future org mode issues: - Add an org mode [banzai pipeline](https://gitlab.com/gitlab-org/gitlab/-/tree/b8bfd637eebcf1d13d74e16fbfcb4c60d8064026/lib/banzai/pipeline) which would allow us to actually go in and sanitize the html produced by the `self.render`. This would also be where we'd include filters that support GFM extensions, such as syntax highlighting[^1], plantuml graphs[^2], etc. - Add [filters](https://gitlab.com/gitlab-org/gitlab/-/tree/b8bfd637eebcf1d13d74e16fbfcb4c60d8064026/lib/banzai/filter) if needed to support the pipeline mentioned above [^1]: See #32207. [^2]: See #23849. <details> <summary>View Sections to be filled out during validation stage</summary> ### Permissions and Security <!-- What permissions are required to perform the described actions? Are they consistent with the existing permissions as documented for users, groups, and projects as appropriate? Is the proposed behavior consistent between the UI, API, and other access methods (e.g. email replies)? Consider adding checkboxes and expectations of users with certain levels of membership https://docs.gitlab.com/ee/user/permissions.html * [ ] Add expected impact to members with no access (0) * [ ] Add expected impact to Guest (10) members * [ ] Add expected impact to Reporter (20) members * [ ] Add expected impact to Developer (30) members * [ ] Add expected impact to Maintainer (40) members * [ ] Add expected impact to Owner (50) members --> ### Documentation <!-- See the Feature Change Documentation Workflow https://docs.gitlab.com/ee/development/documentation/workflow.html#for-a-product-change * Add all known Documentation Requirements in this section. See https://docs.gitlab.com/ee/development/documentation/feature-change-workflow.html#documentation-requirements * If this feature requires changing permissions, update the permissions document. See https://docs.gitlab.com/ee/user/permissions.html --> ### Availability & Testing <!-- This section needs to be retained and filled in during the workflow planning breakdown phase of this feature proposal, if not earlier. What risks does this change pose to our availability? How might it affect the quality of the product? What additional test coverage or changes to tests will be needed? Will it require cross-browser testing? Please list the test areas (unit, integration and end-to-end) that needs to be added or updated to ensure that this feature will work as intended. Please use the list below as guidance. * Unit test changes * Integration test changes * End-to-end test change See the test engineering planning process and reach out to your counterpart Software Engineer in Test for assistance: https://about.gitlab.com/handbook/engineering/quality/test-engineering/#test-planning --> ### What does success look like, and how can we measure that? <!-- Define both the success metrics and acceptance criteria. Note that success metrics indicate the desired business outcomes, while acceptance criteria indicate when the solution is working correctly. If there is no way to measure success, link to an issue that will implement a way to measure this. --> ### What is the type of buyer? <!-- What is the buyer persona for this feature? See https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/buyer-persona/ In which enterprise tier should this feature go? See https://about.gitlab.com/handbook/product/pricing/#four-tiers --> ### Is this a cross-stage feature? <!-- Communicate if this change will affect multiple Stage Groups or product areas. We recommend always start with the assumption that a feature request will have an impact into another Group. Loop in the most relevant PM and Product Designer from that Group to provide strategic support to help align the Group's broader plan and vision, as well as to avoid UX and technical debt. https://about.gitlab.com/handbook/product/#cross-stage-features --> ### Links / references </details>