Skip to content

WIP: Docs: include content from frontmatter data

Marcia Ramos requested to merge docs-include-content into master

What does this MR do?

Through this docs site implementation: gitlab-docs!870 (closed):

  • Makes it possible to render .erb data in .md files. (test.erb.md)
  • Makes it possible to render frontmatter data in the doc itself.

TO-DO: check how it looks on /help.

Review app: http://docs-preview-ee-31880.178.62.207.141.nip.io/ee/test.html

Magic

Consider a document on gitlab, for example doc/test.erb.md that belongs to devopscreate:

---
stage: "DevOps Create"
---

<% if @item[:stage] %>
  <div><%= @item[:stage] %></div>
<% end %>

Renders the stage in its own doc on docs.gitlab.com.

See gitlab-docs!870 (closed) for details.

Related issues

gitlab-docs#737 (closed)

Check this locally

  • Pull this branch docs-include-content
  • Pull the docs site branch fm-data-into-doc
  • Run bundle exec nanoc compile
  • Run bundle exec nanoc live
  • Preview on http://localhost:3000/ee/test.html

Author's checklist (required)

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by 🤖 GitLab Bot 🤖

Merge request reports