Website: Migrate to vitepress #6518

Pandapip1 · 2023-02-17T22:13:19Z

Preview (might be out of date): https://eips.pandapip1.com/

Closes #6483

TODO:

RSS Feeds
Replace Htmlproofer
Remove created field from preamble

Not necessary, nice to have:

Reuse component for listings
Search
PWA

Other Notable Changes

Remove HTMLProofer: we have two link checkers today: HTMLProofer and markdown-link-check. HTMLProofer checks links in the final rendered output, while markdown-link-check checks the pre-rendered markdown. Removing HTMLProofer will significantly speed up builds, but will have less complete coverage.
Remove github-pages health-check: the status of our DNS isn't really a CI issue.
Modify EIP-1: to include up-to-date editor information.

SamWilsn

~~Some~~ One larger questions:

Is it feasible to move any JS code that "does work" into a library, so we can run linters and formatters and such?

SamWilsn · 2023-05-04T18:18:06Z

.github/workflows/ci.yml

-      - name: HTML Proofer
-        run: bundle exec htmlproofer ./_site --check-html --check-opengraph --report-missing-names --log-level=:debug --assume-extension --empty-alt-ignore --timeframe=6w --disable-external


It looks like you're turning off the "check links in the final rendered output" (HTMLProofer) check, so we'd be relying on the markdown link checker entirely. Is my understanding correct, and is that what we want?

Yes, since we want to remove all ruby stuff. If you want, I can put in a new action that runs htmlproofer against the built website.

Hm, I'm sure there's a better option than htmlproofer if we're moving away from Ruby.

.github/workflows/ci.yml

.github/workflows/deploy.yml

.vitepress/config.js

SamWilsn · 2023-05-04T18:51:29Z

.vitepress/config.js

+const eips = Promise.all(fs.readdirSync('./EIPS/').map(async file => {
+    let eipContent = fs.readFileSync(`./EIPS/${file}`, 'utf8');
+    let eipData = grayMatter(eipContent);
+    let lastStatusChange = new Date((await git.raw(['blame', `EIPS/${file}`])).split('\n').filter(line => line.match(/status:/gi))?.pop()?.match(/(?<=\s)\d+-\d+-\d+/g)?.pop());


Does this library automatically add --porcelain? If not, I'd very much recommend using it, or maybe even --line-porcelain.

I know we disallow colons in eipw, but if we change that, we should still expect this tool to work. I'd recommend using /^status:/gi as the regex in case someone puts something dumb in their title.

What is --porcelain?

git has two types of commands: plumbing and porcelain. Plumbing commands are low-level and are used to implement the higher level porcelain commands, while porcelain commands are made to interface with a human.

The --porcelain flag tells porcelain commands to output in a more stable and script friendly format.

I know we disallow colons in eipw, but if we change that, we should still expect this tool to work. I'd recommend using /^status:/gi as the regex in case someone puts something dumb in their title.

How does that break this line?

How does that break this line?

It might, it might not. I'm not sure 🤣 Those were two unrelated thoughts: use --porcelain, and separately, tighten the regex.

.vitepress/config.js

.vitepress/feeds.js

assets/website/html_code.html

eth-bot · 2023-05-14T17:31:17Z

🛑 eip-review-bot failed for an unknown reason. Please see logs for more details, and report this issue at the eip-review-bot repository.

github-actions · 2023-05-15T18:02:44Z

The commit 67a6a88 (as a parent of a8de4c9) contains errors.
Please inspect the Run Summary for details.

xinbenlv · 2023-06-05T17:46:13Z

I like the site a lot. And I don't think Vitepress / HTML is a fair comparison here, probably we are comparing Jekyll vs Vue here..

Anyway, I've redirected eips.ercref.org to https://eips.pandapip1.com/ and will start using it for myself.

@Pandapip1 if you are open to it, we could setup eips.ercref.org or find a proper first level domain for it?

As much as we like to have (evm) client diversity, I've also been a big fan to support dApp diversity.

lightclient · 2023-06-05T18:02:42Z

Vitepress is still in beta so we probably shouldn't be relying on it. I also don't think we should be making the site more complicated. I would rather we focus on making it simpler with less javascript. We don't need complex frontend frameworks to show EIPs.

SamWilsn · 2023-06-05T19:45:15Z

I would rather we focus on making it simpler with less javascript. We don't need complex frontend frameworks to show EIPs.

Very much agreed. I don't know anything about Vue or Vitepress, and I—perhaps naively—assumed this was all executed during the compilation step.

Search, filtering, and any tooltips will likely need to be client-side, however.

xinbenlv · 2023-06-05T21:11:09Z

@lightclient @SamWilsn

It's ok if you feel that this site is not ready to be used for the canonical eips.ethereum.org if there are concerns.

I am in support for this site to be its stand alone to support the EIP/ERC ecosystem.

lightclient · 2023-06-05T21:15:18Z

That's fine, but in that case it should live in a different repo and this PR closed.

xinbenlv · 2023-06-05T21:17:05Z

@Pandapip1 are you ok if this is a stand alone site? I think that reduces the friction for your beautifully designed site to be adopted sooner. And we can keep adding features to it.

Pandapip1 · 2023-06-21T19:58:10Z

Very much agreed. I don't know anything about Vue or Vitepress, and I—perhaps naively—assumed this was all executed during the compilation step.

This is all executed during the compilation step, minus the searching which is done using a little bit of client-side JS, and some minor styling (tooltips, also with client-side JS).

SamWilsn · 2023-06-26T16:29:37Z

This is all executed during the compilation step, minus the searching which is done using a little bit of client-side JS, and some minor styling (tooltips, also with client-side JS).

Great! That takes care of my trepidation about this.

My outstanding concerns:

Can we move any code that "does work" (as opposed to code that "configures") into a library with appropriate linters and code formatters?
Use --porcelain for git commands that accept it.

@lightclient Would I be correct in saying your only remaining objections are:

JavaScript vs. Ruby
vitepress 1.0 is still in beta

Pandapip1 · 2023-07-22T16:00:36Z

Closing since I've forked these changes to a separate repo. If we want to implement this, the website will be in a seperate repo.

https://eip.info is an automatically updated but improved version of these changes.

github-actions · 2023-08-10T00:19:26Z

There has been no activity on this pull request for 2 weeks. It will be closed after 3 months of inactivity. If you would like to move this PR forward, please respond to any outstanding feedback or add a comment indicating that you have addressed all required feedback and are ready for a review.

Pandapip1 · 2023-08-11T09:38:54Z

It appears I forgot to close.

Pandapip1 added 9 commits February 16, 2023 19:12

Commit first version of vue-based rendering system

ba438d9

Make more changes to try to get build to work

7dcf0bc

Commit some changes so far

3d90436

More syntax highlighting fixes

f47f5b3

Fix some package lock stuff

3f8d23a

Commit fixes

8592b2a

Fix citation format

776bb55

Commit a lot of stuff. Not all of it is completely done.

ef1c49a

Finished product!

1bdd65f

github-actions bot added the w-ci Waiting on CI to pass label Feb 17, 2023

Fix some rendering bugs

26a6216

github-actions bot added w-ci Waiting on CI to pass and removed w-ci Waiting on CI to pass labels Feb 17, 2023

Pandapip1 added 2 commits February 17, 2023 17:24

Replace htmlproofer with build website

e4c2dd2

Rename build website to htmlproofer so that CI passes

9e1802e

github-actions bot removed the w-ci Waiting on CI to pass label Feb 17, 2023

Pandapip1 added 2 commits February 17, 2023 17:25

Never mind, it'll need a manual merge anyway :laugh:

f3d388f

Really dum mistakes

a5a10c0

github-actions bot added the w-ci Waiting on CI to pass label Feb 17, 2023

Pandapip1 added 3 commits February 17, 2023 17:50

Add caching

f55e1b4

Fix subtle linking error

68eee13

Remove extra newline

e4eb72e

github-actions bot added w-ci Waiting on CI to pass and removed w-ci Waiting on CI to pass labels Feb 17, 2023

Pandapip1 added 2 commits February 17, 2023 18:05

Build fixed

ebdd4d1

Fix bug with JD json

bcd205f

github-actions bot added w-ci Waiting on CI to pass and removed w-ci Waiting on CI to pass labels Feb 17, 2023

Pandapip1 added 2 commits February 17, 2023 18:13

A crucial step missing

44ada97

Fix some stuff related to meta

1086bde

Pandapip1 added 2 commits March 29, 2023 12:01

Forgot to stage EIP-5252

7d8a6fd

Remove old RSS feeds

62b775a

SamWilsn reviewed May 4, 2023

View reviewed changes

Fix a typo

bd8f7c1

Pandapip1 added 5 commits May 14, 2023 13:33

Delete unused file

b203327

Merge branch 'master' of https://github.com/ethereum/EIPs into use-vue

a3d24e2

Commit changes so far (currently broken)

cc4dff5

Oops typo

b41c938

Typo 2 electric boogaloo

6d6f05a

github-actions bot added w-ci Waiting on CI to pass and removed w-ci Waiting on CI to pass labels May 15, 2023

Pandapip1 added 4 commits May 15, 2023 13:15

Fix EIP-107 (maybe that's the problem?)

6ed7921

Speed up build a lot

cb8e7b7

Add additional checks

00e7916

Add additional optimization

67a6a88

github-actions bot added the w-stale Waiting on activity label Aug 10, 2023

Pandapip1 closed this Aug 11, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Website: Migrate to vitepress #6518

Website: Migrate to vitepress #6518

Pandapip1 commented Feb 17, 2023 •

edited by SamWilsn

Loading

SamWilsn left a comment

SamWilsn May 4, 2023

Pandapip1 May 14, 2023

SamWilsn Jun 5, 2023

SamWilsn May 4, 2023

Pandapip1 May 14, 2023

SamWilsn Jun 5, 2023

Pandapip1 Jun 21, 2023

SamWilsn Jun 26, 2023

eth-bot commented May 14, 2023 •

edited

Loading

github-actions bot commented May 15, 2023

xinbenlv commented Jun 5, 2023 •

edited

Loading

lightclient commented Jun 5, 2023

SamWilsn commented Jun 5, 2023

xinbenlv commented Jun 5, 2023

lightclient commented Jun 5, 2023 •

edited

Loading

xinbenlv commented Jun 5, 2023

Pandapip1 commented Jun 21, 2023 •

edited

Loading

SamWilsn commented Jun 26, 2023 •

edited

Loading

Pandapip1 commented Jul 22, 2023

github-actions bot commented Aug 10, 2023

Pandapip1 commented Aug 11, 2023

		- name: HTML Proofer
		run: bundle exec htmlproofer ./_site --check-html --check-opengraph --report-missing-names --log-level=:debug --assume-extension --empty-alt-ignore --timeframe=6w --disable-external

Website: Migrate to vitepress #6518

Website: Migrate to vitepress #6518

Conversation

Pandapip1 commented Feb 17, 2023 • edited by SamWilsn Loading

Other Notable Changes

SamWilsn left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eth-bot commented May 14, 2023 • edited Loading

github-actions bot commented May 15, 2023

xinbenlv commented Jun 5, 2023 • edited Loading

lightclient commented Jun 5, 2023

SamWilsn commented Jun 5, 2023

xinbenlv commented Jun 5, 2023

lightclient commented Jun 5, 2023 • edited Loading

xinbenlv commented Jun 5, 2023

Pandapip1 commented Jun 21, 2023 • edited Loading

SamWilsn commented Jun 26, 2023 • edited Loading

Pandapip1 commented Jul 22, 2023

github-actions bot commented Aug 10, 2023

Pandapip1 commented Aug 11, 2023

Pandapip1 commented Feb 17, 2023 •

edited by SamWilsn

Loading

eth-bot commented May 14, 2023 •

edited

Loading

xinbenlv commented Jun 5, 2023 •

edited

Loading

lightclient commented Jun 5, 2023 •

edited

Loading

Pandapip1 commented Jun 21, 2023 •

edited

Loading

SamWilsn commented Jun 26, 2023 •

edited

Loading