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

Custom Markdown #2753

Merged
merged 10 commits into from
Jul 19, 2024
Merged

Custom Markdown #2753

merged 10 commits into from
Jul 19, 2024

Conversation

msamper
Copy link
Contributor

@msamper msamper commented Jul 16, 2024

Features and Changes

Introduces the possibility to display custom markdown on several key pages in GrowthBook to allow organizations to provide users with organization-specific guidance.

Pages currently supported are:

  1. Experiment List Page
  2. Experiment Page
  3. Feature List Page
  4. Feature Page
  5. Metric List Page
  6. Metric Page

Custom Markdown users have the option to leverage handlebars variables available on each page and create templates tailored to the page/user. Every page has the following base variables available: orgName and user

The following pages have additional variables available for use:

  • Experiment Page
    • experiment, tags, experimentStatus
  • Feature Page
    • featureKey, tags, featureType
  • Metric Page
    • metricName, tags, metricType, metricDatasource

Testing

On an account with admin access, navigate to General Settings and access the Custom Markdown page at the bottom of the settings page. Try setting some markdown for the some of the pages and ensure that the new Custom Markdown component is rendered on the pages you set markdown for with the correct markdown.

Screenshots

Screenshot 2024-07-18 at 12 06 16 PM Screenshot 2024-07-18 at 12 06 23 PM Screenshot 2024-07-18 at 12 11 53 PM

@msamper msamper changed the title Msamper/custom markdown Custom Markdown Jul 16, 2024
@msamper msamper marked this pull request as ready for review July 17, 2024 00:17
Copy link

github-actions bot commented Jul 17, 2024

Deploy preview for docs ready!

✅ Preview
https://docs-p9yid2t7t-growthbook.vercel.app

Built with commit 053d7a9.
This pull request is being automatically deployed with vercel-action

Copy link

github-actions bot commented Jul 17, 2024

Your preview environment pr-2753-bttf has been deployed.

Preview environment endpoints are available at:

@msamper msamper requested a review from jdorn July 17, 2024 22:40
Copy link
Contributor

@Kevin-Chant Kevin-Chant left a comment

Choose a reason for hiding this comment

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

LGTM

@msamper msamper merged commit 233cb2a into main Jul 19, 2024
6 checks passed
@msamper msamper deleted the msamper/custom-markdown branch July 19, 2024 01:48
lukebrawleysmith pushed a commit that referenced this pull request Jul 24, 2024
* add custom markdown

* Modify CustomMarkdown

* fix markdown

* address comments

* remove console log

* use inline modal for custom markdown settings

* add permission check and commercial feature check

* implement design

* small fix
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.

3 participants