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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update UG and DG site json file to include new plugins #2546

Merged
merged 1 commit into from May 2, 2024

Conversation

EltonGohJH
Copy link
Contributor

@EltonGohJH EltonGohJH commented May 2, 2024

What is the purpose of this pull request?

  • Documentation update
  • Bug fix
  • Feature addition or enhancement
  • Code maintenance
  • DevOps
  • Improve developer experience
  • Others, please explain:

Overview of changes:
Fixes #2451
Update UG and DG site json file to include new plugins

Anything you'd like to highlight/discuss:
I realised that these plugins are not enabled after looking at issue #2529 which is kinda ironic.

Testing instructions:
Merge to master to test. Quite confident this will solve it 馃槅

Proposed commit message: (wrap lines at 72 characters)
Update UG and DG site json file to include new plugins


Checklist: 鈽戯笍

  • Updated the documentation for feature additions and enhancements
  • Added tests for bug fixes or features
  • Linked all related issues
  • No unrelated changes

Reviewer checklist:

Indicate the SEMVER impact of the PR:

  • Major (when you make incompatible API changes)
  • Minor (when you add functionality in a backward compatible manner)
  • Patch (when you make backward compatible bug fixes)

At the end of the review, please label the PR with the appropriate label: r.Major, r.Minor, r.Patch.

Breaking change release note preparation (if applicable):

  • To be included in the release note for any feature that is made obsolete/breaking

Give a brief explanation note about:

  • what was the old feature that was made obsolete
  • any replacement feature (if any), and
  • how the author should modify his website to migrate from the old feature to the replacement feature (if possible).

Copy link
Contributor

@kaixin-hc kaixin-hc left a comment

Choose a reason for hiding this comment

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

lgtm lmao I wish we merged this earlier

@EltonGohJH EltonGohJH merged commit d65c649 into MarkBind:master May 2, 2024
10 of 14 checks passed
@github-actions github-actions bot added the r.Patch Version resolver: increment by 0.0.1 label May 2, 2024
@damithc
Copy link
Contributor

damithc commented May 2, 2024

I realised that these plugins are not enabled after looking at issue #2529 which is kinda ironic.

Good catch, @EltonGohJH

lgtm lmao I wish we merged this earlier

I guess we need to do another release? :-p

@EltonGohJH
Copy link
Contributor Author

EltonGohJH commented May 2, 2024

@damithc
I think @LamJiuFong wants to do more changes after finals.

@kaixin-hc is thinking of doing a release after that if there are any changes.

@damithc
Copy link
Contributor

damithc commented May 2, 2024

@kaixin-hc is thinking of doing a release after that if there are any changes.

It's best to fix the UG sooner rather than later though (as it is a public-facing), if not through a release, then by doing a manual update.

@tlylt
Copy link
Contributor

tlylt commented May 5, 2024

@EltonGohJH does our DG use any of the added plugins? Especially the ones like web3Form? I believe that's the reason why some of these are not added to our DG.

In addition, I think it's fine that we don't include the newly included datatable or mermaid plugins if we don't use them. It should be a valid use case where users can opt to remove the plugins in the site.json file and MarkBind will still work? If so our docs will successfully illustrate that.

@EltonGohJH
Copy link
Contributor Author

@tlylt
I added because I thought it should be consistent but on hindsight maybe I should have only enabled what is used. I agree that our DG can serve as use case for the behaviour for site.json.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
r.Patch Version resolver: increment by 0.0.1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing output for plugins: Web3Forms, datatable, mermaid
4 participants