Skip to content

Conversation

@yeyTaken
Copy link
Contributor

@yeyTaken yeyTaken commented Jan 17, 2025

The site content is ...

@MattIPv4 MattIPv4 changed the title Update cnames_active.js - Added atos - A documentation website for the AtosJS NPM package atos.js.org Jan 17, 2025
@MattIPv4
Copy link
Member

As I noted in #9500, please provide the requested details in the PR template/description, and please resolve the CI errors. You do not need to create a new PR to do that, you can edit the existing PR you have open (this one).

@yeyTaken
Copy link
Contributor Author

I hadn't arranged it in alphabetical order before; now it is done. I think.

@MattIPv4
Copy link
Member

You still haven't provided any information on what your site is in your pull request description, as I've asked for twice now...

Copy link
Member

@MattIPv4 MattIPv4 left a comment

Choose a reason for hiding this comment

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

✅ Commit valid, CNAME present, site appears to have content *

* based off https://github.com/yeyTaken/atosjs/blob/master/README.md

@MattIPv4 MattIPv4 added add This PR/issue is regarding adding a new subdomain user This PR/issue is regarding a target on a GitHub user account project This PR has a target of a project on an organisation or user account and removed invalid labels Jan 17, 2025
@yeyTaken
Copy link
Contributor Author

My website will serve as comprehensive documentation for the AtosJS npm package, showcasing all its classes and features in detail, as outlined in the README.md file. To avoid delays in the official release of version 2, I secured the atos.js.org domain in advance, ensuring everything is ready for the public at launch.

@yeyTaken
Copy link
Contributor Author

The AtosJS documentation site is located in the project structure under 'apps/guide/*'. It will be the official guide for AtosJS, developed with Next.js v14. Once it's done, I plan to host it at Vercel. I would like to confirm that it will work properly on the platform and that there are any specific methods or configurations that I need to follow to ensure proper functioning.

@MattIPv4
Copy link
Member

With your pull request as it stands, you are using GitHub Pages to host your site and it appears you will be serving the README.md file as your website content.

You can also use GitHub Pages to host a static Next.js site, you'll need a GitHub Action to do that, and no changes needed here.

If you want to use Vercel, you'll need to have the subdomain target in the cnames_active.js file be Vercel, not GitHub Pages.

@yeyTaken
Copy link
Contributor Author

Okay, thank you very much! When I deploy it on Vercel, I will modify it there. But I have one question: does the CNAME work the same way on Vercel?

@MattIPv4
Copy link
Member

I suppose the same way, yes. You just add the js.org subdomain as a custom domain in your Vercel project.

@yeyTaken
Copy link
Contributor Author

thanks!

@indus
Copy link
Member

indus commented Jan 18, 2025

Welcome https://atos.js.org
@yeyTaken keep in mind that transition to vercel may take some time as the DNS records have some TTL or may get cached by some systems.

@indus indus merged commit 76441a5 into js-org:master Jan 18, 2025
1 check passed
@yeyTaken
Copy link
Contributor Author

It's okay, I'm not in a hurry, I'm finishing the website yet.

@yeyTaken
Copy link
Contributor Author

Finish the site and I've already deployed it to Vercel. How do I add the atos.js.org domain in Vercel?

image

@yeyTaken
Copy link
Contributor Author

image

@indus
Copy link
Member

indus commented Jan 19, 2025 via email

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

Labels

add This PR/issue is regarding adding a new subdomain project This PR has a target of a project on an organisation or user account user This PR/issue is regarding a target on a GitHub user account

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants