feat(docs): build docs in CI and deploy to gh pages #849

lwasser · 2025-08-21T23:58:25Z

closes #835

What:
Right now the all contributors.org website is down. Using GitHub Pages will allow us to deploy the website to GitHub Pages. When we have control of the domain, we can migrate the DNS to GitHub Pages. This pr is partially working. What doesn't work right now is the links to the docs page - this is because i need some input on how translations work. But I wanted folks to see that moving to GitHub Pages is straightforward and could make maintenance easier.
Why:

I just set up GitHub Pages deploy via a CI action. We will need to adjust the settings and such for this to all work correctly. Then we'd want to setup security for the domain when we have access to it so people can't steal subdomains and use them for bad things... 🙃 sadly this happens.

How:

Checklist:

Documentation
Ready to be merged
Added myself to contributors table.
Bot Usage

lwasser · 2025-08-21T23:58:55Z

docs/emoji-key.md

-📖 <br /> `doc` | Documentation | Links to commits by the user on this project, Wiki, or other source of documentation
-🎨 <br /> `design` | Design | Links to the logo/iconography/visual design/etc.
-💡 <br /> `example` | Examples | Links to the examples
+Emoji/Type | Represents | Comments |


The linter was failing because of the missing closing table tags.

lwasser · 2025-08-22T00:00:10Z

website/siteConfig.js

    // For deploy
-    url: 'https://allcontributors.org',
-    baseUrl: '/',
+    url: 'https://leahwasser.com',


obviously we would update this. but you can see this live at

https://www.leahwasser.com/all-contributors

note: the docs link at the top is broken but easily fixed. Right now, it's a hard link, and I'm not sure why that entire index page is pure HTML. but easy to update and fix once we decide this is the path we want to go down.

It would be worth adding a TODO comment so one of us can remember to update that when needed.

@Berkmann18 rather than merging this as is, what i'd like to do here is get this running on github pages here in this repo! So the url would be all-contributors.github.io . To do that, i need access to the settings in this repo or I need someone else to set that up for us so we can get the website online again. Below is what i see when i go to settings in this repo.

Could you help with that? Either give me permissions to do it OR you could set it up if you are uncomfortable with giving me permissions (which i understand!)

I have access now so please ignore the above!! This pr however is ready to merge WHEN everyone is happy with it!!

lwasser · 2025-08-22T00:00:43Z

website/static/index.html

      type="image/png"
      sizes="16x16"
-      href="/img/icons/favicon-16x16.png"
+      href="img/icons/favicon-16x16.png"


This entire page is pure html which surprised me! we probably want to consider a markdown version in the future but for now - html it is.

website/static/index.html

docs/project/contribute.md

Berkmann18 · 2025-08-25T16:07:29Z

docs/project/contribute.md

+
+`node -v`
+
+If you don't have atleast version `.18` or higher, please install node or upgrade your current version.


If this is for the Node version, v24 should be the oldest to accept, as it's the current LTS version. v18 has been out of support for several years.

Definitely. The entire docs website is out of date with a lot of deprecated dependencies. I will test this locally and then update!! Great catch!

Berkmann18 · 2025-08-25T16:07:56Z

docs/project/contribute.md

+
+If you don't have atleast version `.18` or higher, please install node or upgrade your current version.
+
+Install the newest (deprecated) version of Docusaurus:


Do they not have an undeprecated version?

They do. Can you please have a look as this open issue . Essentially if we want to move the entire site to the newest version, we will need to update the structure of the documentation. This structure will impact crowdin's setup. We are 2 versions behind on these docs. SO I think because I don't have access to crowdin beyond adding translations I don't want to break translations until we know we have full admin access to platforms (or we have a plan in place to migrate translations.

Update - thank you for giving me access to crowdin! we can now figure out how to sync github pages with translation content and also setup github pages 🚀 I suggest still that we get the site live as is FIRST and then we migrate to Docusaurus 3.x and update all deps at that time!!

Yeah, getting it working then migrating to a later version of Docusaurus is a good plan.

Ok perfect. I also saw the updates you made to the pr title. I'll read a bit more about angular / conventional commits as well.

Berkmann18 · 2025-08-25T16:09:05Z

website/siteConfig.js

    // For deploy
-    url: 'https://allcontributors.org',
-    baseUrl: '/',
+    url: 'https://leahwasser.com',


It would be worth adding a TODO comment so one of us can remember to update that when needed.

Berkmann18 · 2025-08-25T16:09:48Z

website/siteConfig.js

+    baseUrl: '/all-contributors/',
    projectName: 'all-contributors',
-    organizationName: 'all-contributors',
+    organizationName: 'lwasser',


Ditto about leaving a TODO (especially useful for those who have TODO extensions that highlight those comments).

Definitely. Please see comment above - i proposal we get the homepage online via github pages so i'd make this all-contributors before merging if we do that! This pr will allow us to get that home page online with those changes once we setup things up in the settings of this repo.

website/siteConfig.js

lwasser · 2025-08-25T21:42:33Z

Ok i've updated this so it should build on github pages and responded to all review comments. @Berkmann18 please have a look when you have a moment.

lwasser · 2025-08-26T20:33:15Z

Ok great - just fixed a merge conflict. This pr is ready for another review @Berkmann18 !! 🚀

lwasser · 2025-08-27T00:16:33Z

Thanks for the review and approval @Berkmann18 i'll merge this and we can see how github pages goes

lwasser · 2025-08-27T00:31:54Z

Noting that GhPages was actually setup in the settings for this repo. I just removed it as the branch hadn't been updated in 6 years. I moved to a better / gh actions based deployment.

I'll create an issue to setup dependabot for security updates.

lwasser commented Aug 21, 2025

View reviewed changes

lwasser commented Aug 22, 2025

View reviewed changes

website/static/index.html Outdated Show resolved Hide resolved

Berkmann18 changed the title ~~enh(docs): build docs in CI and deploy to gh pages~~ feat(docs): build docs in CI and deploy to gh pages Aug 25, 2025

Berkmann18 reviewed Aug 25, 2025

View reviewed changes

lwasser force-pushed the docs branch from 59080c8 to da80a81 Compare August 25, 2025 21:37

lwasser commented Aug 25, 2025

View reviewed changes

website/siteConfig.js Outdated Show resolved Hide resolved

lwasser force-pushed the docs branch from 4f4e710 to 6b26409 Compare August 25, 2025 21:40

docs(gha): setup gha to build docs and ensure site builds

2946879

lwasser force-pushed the docs branch from 6b26409 to 2946879 Compare August 25, 2025 21:41

lwasser marked this pull request as ready for review August 25, 2025 21:41

lwasser mentioned this pull request Aug 26, 2025

Security risk: Let's move to Lychee for broken links (and a note about other deps) #852

Closed

Merge branch 'master' into docs

8e54a88

Berkmann18 approved these changes Aug 26, 2025

View reviewed changes

lwasser merged commit 1147732 into all-contributors:master Aug 27, 2025
6 checks passed


		`node -v`

		If you don't have atleast version `.18` or higher, please install node or upgrade your current version.


		If you don't have atleast version `.18` or higher, please install node or upgrade your current version.

		Install the newest (deprecated) version of Docusaurus:

feat(docs): build docs in CI and deploy to gh pages #849

feat(docs): build docs in CI and deploy to gh pages #849

Uh oh!

Conversation

lwasser commented Aug 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

lwasser commented Aug 25, 2025

Uh oh!

lwasser commented Aug 26, 2025

Uh oh!

lwasser commented Aug 27, 2025

Uh oh!

Uh oh!

lwasser commented Aug 27, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

lwasser commented Aug 21, 2025 •

edited

Loading