docs-site icon indicating copy to clipboard operation
docs-site copied to clipboard

POC for docs filtering feature

Open skurnevich opened this issue 3 years ago • 2 comments

Signed-off-by: Sergei Kurnevich [email protected]

Description

Related to https://github.com/zowe/docs-site/issues/1767 and https://github.com/zowe/zlux/issues/692

POC: Adds tags selection component, allowing to filter document content using tags specified in .md file meta section.

Screenshot 2021-09-21 at 17 04 31

Example of .md file to work with these changes:

---
meta:
  - tags: {
      desktop: ["Desktop"],
      cli: ["Zowe CLI"],
      racf: ["#hidden-header"],
      acf2: ["#hidden-header2"]
    }
---

# Page header

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

## Desktop

Zowe Desktop part. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

## Zowe CLI

Zowe CLI part. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

## Another CLI

Another Zowe CLI part. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

###### {#hidden-header}

Paragraph that is related to the RACF ESM.

###### {#hidden-header2}

Another paragraph that is related ACF2 ESM.

###### {#hidden-header3}

Third paragraph not related to any tag

skurnevich avatar Sep 08 '21 15:09 skurnevich

❌ Deploy Preview for zowe-docs-master failed.

🔨 Explore the source changes: 536a442f040b97167921ae9e90188e9bbd4c3ee3

🔍 Inspect the deploy log: https://app.netlify.com/sites/zowe-docs-master/deploys/6149f36f1b171e0007486c28

netlify[bot] avatar Sep 08 '21 15:09 netlify[bot]

I decided not to for now, because the scope is bigger but I might come back to it. I'll be picking up & updating the Docs Glossary PR though

DivergentEuropeans avatar Jul 18 '23 18:07 DivergentEuropeans