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.

Sign up for GitHub

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

Jump to bottom

Update installation docs to use templates esbuild instructions #2827

Closed
wants to merge 9 commits into from
Closed

Update installation docs to use templates esbuild instructions #2827

wants to merge 9 commits into from

Conversation

kevinfiol
Copy link
Contributor

@kevinfiol kevinfiol commented Apr 6, 2023 •
edited
Loading

Removes wordy "Step by Step" section of the installation page, as well instructions on using budo, and adds Mithril starter templates that are easy to clone. Also rewrites Quick start section to use esbuild instead of Webpack.

Description

Review the rendered markdown here.

Motivation and Context

  • Why is this change required? What problem does it solve?
    • Simplifies installation documentation
    • Moves the documentation to use newer, more up-to-date and performant tools. Webpack has a much larger dependency graph while being far less performant than esbuild, rollup, or Vite.

For some notes on why I went with esbuild as the "default":

  • Usage is dead simple since it's primary usage is through the CLI; no config needed to write an npm script
  • It's a small-ish static binary and is well suited for single-page applications, which Mithril embraces
  • Appeals to minimalists and folks unfamiliar with JS ecosystem. See this post
  • It will arguably be around longer than Vite (fwiw, Vite sits on top of esbuild)

How Has This Been Tested?

Ran npm run build:docs locally and reviewed built documentation

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation change

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • I have updated docs/changelog.md

dependabot bot and others added 5 commits February 7, 2023 04:59
@dependabot
Bump minimatch from 3.0.4 to 3.1.2
726d3bf 
Bumps [minimatch](https://github.com/isaacs/minimatch) from 3.0.4 to 3.1.2.
- [Release notes](https://github.com/isaacs/minimatch/releases)
- [Changelog](https://github.com/isaacs/minimatch/blob/main/changelog.md)
- [Commits](isaacs/minimatch@v3.0.4...v3.1.2)

---
updated-dependencies:
- dependency-name: minimatch
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot
Bump async from 2.6.3 to 2.6.4
a1159b7 
Bumps [async](https://github.com/caolan/async) from 2.6.3 to 2.6.4.
- [Release notes](https://github.com/caolan/async/releases)
- [Changelog](https://github.com/caolan/async/blob/v2.6.4/CHANGELOG.md)
- [Commits](caolan/async@v2.6.3...v2.6.4)

---
updated-dependencies:
- dependency-name: async
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>
@kfule @dead-claudia
hyperscript: handles shared empty attrs, fixes MithrilJS#2821
88da9e5
@mtsknn @dead-claudia
Fix typos in stream() docs (MithrilJS#2825)
ad9aa97 
Co-authored-by: Claudia Meadows <[email protected]>
@kevinfiol
update installation docs to use templates esbuild
06a9cdc
@kevinfiol kevinfiol changed the title Update installation docs to use templates esbuild Update installation docs to use templates esbuild instructions Apr 6, 2023
tbreuss
tbreuss reviewed May 21, 2023
View reviewed changes
Copy link
Contributor

@tbreuss tbreuss left a comment

Choose a reason for hiding this comment

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

I went through your instructions by all doing it by myself. Everything worked as expected. Nice and consise.

docs/installation.md Outdated Show resolved Hide resolved
docs/installation.md
npm install

# Build the app and watch for changes
npm run dev
Copy link
Contributor

@tbreuss tbreuss May 21, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Seems like port 8080 is the default. Maybe a hint could be helpful how to solve this, if port 8080 is already in use (in my case traefik).

port-8080-already-in-use

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I updated the port used by the esbuild template, and the dev script should log the port to the console by default.

docs/installation.md Outdated Show resolved Hide resolved
@dead-claudia dead-claudia added Area: Documentation For anything dealing mainly with the documentation itself Type: Enhancement For any feature request or suggestion that isn't a bug fix labels Sep 2, 2024
@dead-claudia dead-claudia requested a review from a team as a code owner September 23, 2024 11:58
JAForbes
JAForbes previously approved these changes Sep 23, 2024
View reviewed changes
Copy link
Collaborator

@JAForbes JAForbes left a comment

Choose a reason for hiding this comment

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

Would be so great to have the webpack instructions gone, this looks great.

@kevinfiol
Copy link
Contributor Author

Been a while since I looked at this. I'll make a note to take a look today/this week to fix the formatting and update the templates.

FWIW, I think any templates should probably be under the MithrilJS org.

@kevinfiol
Copy link
Contributor Author

OK pushed up my changes/fixes, and also went ahead and updated the esbuild rollup template repos.

@JAForbes
Copy link
Collaborator

@dead-claudia does this need to target the new docs repo now?

@dead-claudia
Copy link
Member

@JAForbes Yes.

@dead-claudia
Copy link
Member

@kevinfiol Please recreate this against https://github.com/MithrilJS/docs

@kevinfiol kevinfiol mentioned this pull request Sep 24, 2024
Merged
11 tasks
@kevinfiol
Copy link
Contributor Author

Thanks @dead-claudia . Opened MithrilJS/docs#7

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dead-claudia dead-claudia Awaiting requested review from dead-claudia

@StephanHoyer StephanHoyer Awaiting requested review from StephanHoyer

@JAForbes JAForbes Awaiting requested review from JAForbes

@tbreuss tbreuss Awaiting requested review from tbreuss

Assignees
No one assigned
Labels
Area: Documentation For anything dealing mainly with the documentation itself Type: Enhancement For any feature request or suggestion that isn't a bug fix
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@kevinfiol @JAForbes @dead-claudia @tbreuss @kfule @mtsknn