[UI] Dynamically adding front-matter to documentation pages #379

SAHU-01 · 2024-09-30T07:12:09Z

Notes for Reviewers

This PR fixes #89

It adds front-matter to respective documented pages sharing the subscription tier this feature is available to.
This is done dynamically with populating data from the pricing-list workflow and based on the data received, a go script adds the front-matter to their respective documented pages.

Signed commits

Yes, I signed my commits.

…ricing-list workflow Signed-off-by: Ankita Sahu <[email protected]>

netlify · 2024-09-30T07:12:25Z

✅ Deploy Preview for bejewelled-pegasus-b0ce81 ready!

Name	Link
🔨 Latest commit	`175d72f`
🔍 Latest deploy log	https://app.netlify.com/sites/bejewelled-pegasus-b0ce81/deploys/67163b592529fa0008f0c44f
😎 Deploy Preview	https://deploy-preview-379--bejewelled-pegasus-b0ce81.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Signed-off-by: Ankita Sahu <[email protected]>

vishalvivekm · 2024-09-30T18:53:04Z

// @lekaf974

.github/workflows/pricing-list.yml

lekaf974 · 2024-09-30T22:38:03Z

.github/workflows/pricing-list.yml

+
+      - name: Wait for Pricing List workflow to complete
+        run: |
+          # You may need to implement a polling mechanism here to check the status of the other workflow


Could we consider that the other workflow trigger this one once done ?

Yes, we can have the other workflow trigger this one when it's done, rather than relying on a polling mechanism.

lekaf974 · 2024-09-30T22:39:15Z

.github/workflows/pricing-list.yml

+
+      - name: Pull latest changes
+        run: |
+          git pull origin master


What the reason to pull master since a previous step is already doing a checkout ?

The reason for pulling from master after the checkout step is because the first workflow (which generates the pricing-data.json) pushes changes to the repository, so when the current workflow runs, it needs to pull the updated data to ensure it has the latest pricing-data.json. This ensures the front matter is updated based on the most recent pricing information generated by the other workflow.

But you're right! Since we are performing the checkout after triggering the other workflow, the newly added or modified .json file from the "generate-pricing-list.yml" workflow should already be included when the checkout step is executed.

lekaf974 · 2024-09-30T22:42:21Z

update_frontmatter.go

+
+func main() {
+	// Read the JSON file
+	jsonFile, err := ioutil.ReadFile("pricing_data.json")


From where the file is coming ?

Could we also use a environment variable instead of hardcoded value for the file name ?

This file is added from the "generate-pricing-list.yml" workflow call.

Yes, we can absolutely use an environment variable, I'll add one, Thanks!

lekaf974 · 2024-09-30T22:54:12Z

update_frontmatter.go

+
+			// Extract hash if present
+			urlHash := ""
+			for i, part := range urlParts {


I'd rather put this logic in a separate method with a extractHah to make code more readable and to remove the comment

lekaf974 · 2024-09-30T22:54:37Z

update_frontmatter.go

+			}
+
+			// Build the path step by step
+			for _, part := range urlParts {


same buildPath

lekaf974 · 2024-09-30T23:44:46Z

update_frontmatter.go

+
+	if urlHash == "" {
+		// No hash: add shortcode after the front matter
+		frontMatterEnd := strings.Index(contentStr, "---")


same here having a method with proper name for readability

lekaf974 · 2024-09-30T23:44:54Z

update_frontmatter.go

+		}
+	} else {
+		// Hash present: search for matching heading and add shortcode below
+		hashPattern := strings.ReplaceAll(urlHash, "-", "[-\\s]")


same here having a method with proper name for readability

Co-authored-by: Matthieu Evrin <[email protected]> Signed-off-by: Lee Calcote <[email protected]>

leecalcote · 2024-10-06T23:26:22Z

Suggested changes accepted.

Signed-off-by: Ankita Sahu <[email protected]>

lekaf974 · 2024-10-07T11:41:26Z

update_frontmatter.go

+		return
+	}
+
+	// Group entries by documentation URL


@SAHU-01

You can remove all the comments since just reading the code is enough to understand what it is doing.

Usually comments are used for developers documentation or if the algorithm is doing something complex or we need to have context to understand which is not the case here.

Otherwise LGTM

Sure, I'll get rid of all the comments, Thanks!

lekaf974 · 2024-10-07T11:56:33Z

@sudhanshutech

I did reviews on go script but could you review the html css part I'm less comfortable on this

leecalcote · 2024-10-09T02:53:57Z

It's coming along!

vishalvivekm · 2024-10-14T05:20:45Z

@SAHU-01
will you push these changes ( with the not working svgs):
https://www.youtube.com/watch?v=L2bG-kfR5u4&t=2868s

Signed-off-by: Ankita Sahu <[email protected]>

Signed-off-by: Vivek Vishal <[email protected]>

vishalvivekm · 2024-10-21T01:29:22Z

@SAHU-01
Let's discuss the recent changes and update on the item today, during the website call at 5:30 PM IST (7:00 AM CT).

Please add it as an agenda item to the meeting minutes.

Signed-off-by: Ankita Sahu <[email protected]>

…ricing page added Signed-off-by: Ankita Sahu <[email protected]>

Signed-off-by: Ankita Sahu <[email protected]>

vishalvivekm · 2024-10-21T11:14:47Z

@SAHU-01 Let's discuss the recent changes and update on the item today, during the website call at 5:30 PM IST (7:00 AM CT).

Please add it as an agenda item to the meeting minutes.

adding

Signed-off-by: Ankita Sahu <[email protected]>

SAHU-01 · 2024-10-21T15:37:15Z

This flowchart explains how the workflows are working: https://playground.meshery.io/extension/meshmap?mode=design&design=cbb68338-be01-4e0c-b833-3b88c024ca61

leecalcote · 2024-10-22T03:26:40Z

.github/workflows/feature-list.yml

+          script: |
+            const result = await github.rest.actions.createWorkflowDispatch({
+              owner: 'layer5labs',
+              repo: 'meshery-extensions-packages',


What's the purpose of running the workflow over here? @vishalvivekm @SAHU-01 @jerensl

[UI] Dynamically addign frontmatter to documentation pages based on p…

367321e

…ricing-list workflow Signed-off-by: Ankita Sahu <[email protected]>

github-actions bot added component/cloud-docs component/kanvas-doc labels Sep 30, 2024

removing unwanted commented code

3cc1bd8

Signed-off-by: Ankita Sahu <[email protected]>

lekaf974 reviewed Sep 30, 2024

View reviewed changes

.github/workflows/pricing-list.yml Outdated Show resolved Hide resolved

lekaf974 reviewed Sep 30, 2024

View reviewed changes

.github/workflows/pricing-list.yml Outdated Show resolved Hide resolved

lekaf974 reviewed Sep 30, 2024

View reviewed changes

update_frontmatter.go Outdated

}

// Build the path step by step

for _, part := range urlParts {

Copy link

lekaf974 Sep 30, 2024

Choose a reason for hiding this comment

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

same buildPath

lekaf974 reviewed Sep 30, 2024

View reviewed changes

Apply suggestions from code review

c4e5601

Co-authored-by: Matthieu Evrin <[email protected]> Signed-off-by: Lee Calcote <[email protected]>

[UI] applying suggested changes

6418131

Signed-off-by: Ankita Sahu <[email protected]>

lekaf974 suggested changes Oct 7, 2024

View reviewed changes

lekaf974 requested a review from sudhanshutech October 7, 2024 11:55

SAHU-01 and others added 5 commits October 18, 2024 21:06

Merge branch 'layer5io:master' into master

024f9c2

[UI] SVG updated

5eacdf3

Signed-off-by: Ankita Sahu <[email protected]>

Merge branch 'master' of https://github.com/SAHU-01/docs

d3c5021

Merge branch 'master' into master

dc234ce

Merge branch 'master' into master

6c4aa68

Signed-off-by: Vivek Vishal <[email protected]>

Workflow updated

199a1c5

Signed-off-by: Ankita Sahu <[email protected]>

SAHU-01 added 2 commits October 21, 2024 15:29

Frontmatte rPartial updated to show multiple tiers and hyperlink to p…

bb7004b

…ricing page added Signed-off-by: Ankita Sahu <[email protected]>

Removing unwanted files

9b61177

Signed-off-by: Ankita Sahu <[email protected]>

requested changes updated

175d72f

Signed-off-by: Ankita Sahu <[email protected]>

leecalcote reviewed Oct 22, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[UI] Dynamically adding front-matter to documentation pages #379

[UI] Dynamically adding front-matter to documentation pages #379

SAHU-01 commented Sep 30, 2024

netlify bot commented Sep 30, 2024 •

edited

Loading

vishalvivekm commented Sep 30, 2024 •

edited

Loading

lekaf974 Sep 30, 2024

SAHU-01 Oct 7, 2024

lekaf974 Sep 30, 2024

SAHU-01 Oct 7, 2024 •

edited

Loading

lekaf974 Sep 30, 2024

SAHU-01 Oct 7, 2024

lekaf974 Sep 30, 2024

lekaf974 Sep 30, 2024

lekaf974 Sep 30, 2024

lekaf974 Sep 30, 2024

leecalcote commented Oct 6, 2024

lekaf974 Oct 7, 2024 •

edited

Loading

SAHU-01 Oct 7, 2024

lekaf974 commented Oct 7, 2024

leecalcote commented Oct 9, 2024

vishalvivekm commented Oct 14, 2024 •

edited

Loading

vishalvivekm commented Oct 21, 2024

vishalvivekm commented Oct 21, 2024

SAHU-01 commented Oct 21, 2024

leecalcote Oct 22, 2024

[UI] Dynamically adding front-matter to documentation pages #379

Are you sure you want to change the base?

[UI] Dynamically adding front-matter to documentation pages #379

Conversation

SAHU-01 commented Sep 30, 2024

netlify bot commented Sep 30, 2024 • edited Loading

✅ Deploy Preview for bejewelled-pegasus-b0ce81 ready!

vishalvivekm commented Sep 30, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SAHU-01 Oct 7, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

leecalcote commented Oct 6, 2024

lekaf974 Oct 7, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lekaf974 commented Oct 7, 2024

leecalcote commented Oct 9, 2024

vishalvivekm commented Oct 14, 2024 • edited Loading

vishalvivekm commented Oct 21, 2024

vishalvivekm commented Oct 21, 2024

SAHU-01 commented Oct 21, 2024

Choose a reason for hiding this comment

netlify bot commented Sep 30, 2024 •

edited

Loading

vishalvivekm commented Sep 30, 2024 •

edited

Loading

SAHU-01 Oct 7, 2024 •

edited

Loading

lekaf974 Oct 7, 2024 •

edited

Loading

vishalvivekm commented Oct 14, 2024 •

edited

Loading