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

Request to merge in new website #1013

Open
Songtech-0912 opened this issue Nov 20, 2024 · 5 comments
Open

Request to merge in new website #1013

Songtech-0912 opened this issue Nov 20, 2024 · 5 comments

Comments

@Songtech-0912
Copy link
Contributor

After 3 years of development, the new website is done! A huge shout-out to @Shrinks99 and Siddhant for making this possible! A preview can be seen here.

In terms of technical information:

  • The site is a modern Jekyll site that comes with GitHub actions already, basically all batteries-included
  • The website is completely content-complete and ready for launch
    • It also has release notes ready on its news page
    • And all the installers/packages/binaries we build in one place, the links to github releases are templated instead of hardcoded so that will be a lot less work going forwards
    • It provides a good foundation for us to add e.g. article tutorials because all the content is markdown and easy to add new content to, especially in something like Obsidian
  • A few concerns raised were:
    • Licensing issues (we have all assets embedded in the website, with their licenses, but it makes licensing annoying and privacy issues), which we wanted a package manager for, but the overhead was just too much and we couldn't make it work

So I think everything is ready for launch! The process for launch, as I understand, would be something like this:

  • Have a final review before the go-ahead (although imo the website should be good as-is)
  • Rename and archive the existing natron website repository, maybe to a name like natron-legacy-website
  • Transfer ownership of the repo from Hank’s GitHub over to Natron’s official Github

I hope we can get this finally out there! @devernay @bonalex01dev I would love if you could take a look at this, and if things look okay, give the go-ahead.

@devernay
Copy link
Member

devernay commented Nov 20, 2024

Can you tell us a bit more what actions have to be done when a new release comes out?

The current release (2.5) doesn't work on Apple SIlicon Macs, so I should have a different download link for Apple SIlicon Macs that points to the 2.6.0 alpha. How easy is it to do? The 2.5 download should be "macOS (Intel only)", and there should be a link to the prerelease (maybe just the GH page is ok) for Apple SIlicon

@Songtech-0912
Copy link
Contributor Author

Songtech-0912 commented Nov 20, 2024

Yes, certainly! The process is fairly straightforward. First, I forgot to mention, (my copy of) the new website repository is here, Hank's is equivalent.

  1. There is a _config.yml in the root folder, where, so long as our naming conventions for the CI-built binaries remain the same, you literally just need to change the values of 3 keys (takes about 15 seconds to do)
  2. In the site_collections/_posts folder, that's where the release news is, create a new markdown file with the release info. But copying the changelog over is basically enough, and we'd have a changelog for releases anyways.
  3. In templates/releasegraphic Hank wrote a really nice Python script that you can call with a single commandline to automatically generate a release graphic.
  4. That's all! Push and the release is done.

That's basically it! @Shrinks99 correct me if I'm missing some stuff but I think this should be it. As for adding a download link, that is quite quick actually. I may be able to do it tonight after schoolwork.

@Shrinks99
Copy link
Contributor

Yeah adding a download link itself is pretty easy, making it work nicely with GitHub releases and variables requires slightly more thought (naming conventions of builds). I'd just do it as a one-off and then update along with 2.6.0.

@Songtech-0912
Copy link
Contributor Author

@Shrinks99 I made a PR with the changes Fred suggested as well as detailed information to update the site for each new release, see Shrinks99/NatronGitHub.github.io#14

@Shrinks99
Copy link
Contributor

Merged! @devernay I believe all of your above requests have been handled in that PR :)

Detailed release instructions can be found in the readme file
.

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

No branches or pull requests

3 participants