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

UG -> Getting Started: Make it more user-friendly by adding Node.js/npm instructions #2589

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

seah-minlong
Copy link

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:

Fixes #2575

Overview of changes:

  • Adds guide on installing Node.js and npm
  • Rephrased some sentences in Getting Started -> UG

Anything you'd like to highlight/discuss:
The Node LTS Error mentioned in #2575 has been fixed in PR #2572, but the website MarkBind Getting Started page has not been updated to reflect this change yet.

Testing instructions:

Proposed commit message: (wrap lines at 72 characters)
Add installing node.js and npm instructions to Getting Started UG


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

@gerteck gerteck left a comment

Choose a reason for hiding this comment

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

Thanks for the PR!

Regarding the Node LTS Error, it has already been removed, and it is viewable on the latest documentation linked in the repository readme.

The MarkBind website for the current MarkBind release is at https://markbind.org/.
The website for the latest master branch (not yet released to the public) is at https://markbind-master.netlify.app/.

The last time the MarkBind website was updated was on the date of the latest MarkBind release, so there is a difference between the two, although I should have edited the relevant portion in the user guide with the PR that fixed the issue.

For guidance on how to install npm / node, maybe you could explore the use of a expandable panel, since it would be optional (but good to know) information

Is there any purpose behind the rephrasing of the instructions? Seems slightly unnecessary

The versions should match or exceed the requirements mentioned in the Prerequisites.

---

Copy link
Contributor

Choose a reason for hiding this comment

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

As this section is applicable to only some readers, perhaps put it inside a collapsed panel or a modal?

Copy link
Author

Choose a reason for hiding this comment

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

Thanks for the review! @gerteck also suggested the use of an expandable panel so I'll implement it that way

@seah-minlong
Copy link
Author

Thanks for clarifying about the Node LTS error issue @gerteck!

I think the expandable panel is a great suggestion, I shall add that in 😄 .

Regarding the rephrasing, I was aiming to make the instructions feel less intimidating for beginners, but if you think it doesn’t add much value, I can revert or tweak it. Just let me know!

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.

UG -> Getting Started: Make this section more user friendly
3 participants