patternfly / patternfly/patternfly-org

add metadata on md files to store the version

Open
#3,507 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

PF Team PF5
Dominant language
JavaScript
Stars
74
Forks
147
Avg merge
4d 11h
Merged PRs (30d)
2

Description

Followup for https://github.com/patternfly/patternfly/issues/5376

we have access to pageData via ## This is the {pageData.id} component

@mcoker https://github.com/patternfly/patternfly/pull/5434#discussion_r1160917866


Jira Issue: PF-597

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked parseMD.js location and inspect how pageData is exposed for Markdown pages. Read the referenced PatternFly issue and pull request discussion to determine which version metadata is required and where it should be stored. Done means Markdown files carry the agreed version metadata and the documentation framework can access it through the relevant page data.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.