Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

POC for docs filtering feature #1816

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

skurnevich
Copy link
Collaborator

@skurnevich skurnevich commented Sep 8, 2021

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

Description

Related to #1767 and zowe/zlux#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

Signed-off-by: Sergei Kurnevich <[email protected]>
@netlify
Copy link

netlify bot commented Sep 8, 2021

❌ Deploy Preview for zowe-docs-master failed.

🔨 Explore the source changes: 536a442

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

Signed-off-by: Sergei Kurnevich <[email protected]>
Signed-off-by: Sergei Kurnevich <[email protected]>
Copy link
Member

@DivergentEuropeans DivergentEuropeans left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a great idea, kudos to the both of you for starting that. I'd approve it, it's just gotten so old now. I wonder if I'll have time to pick this up again

@DivergentEuropeans
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants