Tools: 鈽傦笍 Path to a published release

Created on 12 May 2020  路  8Comments  路  Source: rome/tools

This issue is tracking the remaining tasks before we have an official release.

This will hopefully be done by the end of the work. There's some additional things to work out.

  • [ ] Rework website

I'm handling this one. I want a mostly single-page website for 90% of people. Not single page as in SPA, single page as in a single page to scroll through.

Taking inspiration from classic projects such as coffeescript.org, backbonejs.org, and underscorejs.org.

I find the current structure of most open source projects to be extremely confusing. Someone should be able to spend 20 minutes reading through the Rome documentation and have a good grasp on how to use almost all of it (we'll see).

  • [x] Add more tests

Tests are lacking in many areas. Notably @romejs/core.

  • [x] Automated releases

After the initial release I want to be able to push new release really quickly. I am fine doing multiple releases a day. Patch and minor versions are cheap.

This means we need to invest in tooling to quickly publish releases. It should be semi-automated, just running a command or pushing to a branch should trigger a release.

Most helpful comment

I'm handling this one. I want a mostly single-page website for 90% of people. Not single page as in SPA, single page as in a single page to scroll through.

Taking inspiration from classic projects such as coffeescript.org, backbonejs.org, and underscorejs.org.

I find the current structure of most open source projects to be extremely confusing. Someone should be able to spend 20 minutes reading through the Rome documentation and have a good grasp on how to use almost all of it (we'll see).

Just a thought about clear docs. It's hard to express how much I value the versioned docs dropdown I've seen in the elixir community (linked below for reference), and the impact that that has had on the community's ability to be welcoming to newcomers. If it's something you're up for, I'd love to help make it happen. Not trying to assert that this should occur before published release or anything, just saying I think it might be nice at some point.

https://hexdocs.pm/elixir/1.10.1/Kernel.html
Screen Shot 2020-05-16 at 12 54 33 PM

All 8 comments

I don't think it makes sense to have blockers on pending features or missing lint rules.

Do we have any target on what the publish version should be capable of doing?

Everything it does now. There's no other launch blockers besides a new website and additional tests.

I want a mostly single-page website for 90% of people. Not single page as in SPA, single page as in a single page to scroll through.

I made a documentation tool for this: https://docup.now.sh, would love some feedback from you 馃

I'm handling this one. I want a mostly single-page website for 90% of people. Not single page as in SPA, single page as in a single page to scroll through.

Taking inspiration from classic projects such as coffeescript.org, backbonejs.org, and underscorejs.org.

I find the current structure of most open source projects to be extremely confusing. Someone should be able to spend 20 minutes reading through the Rome documentation and have a good grasp on how to use almost all of it (we'll see).

Just a thought about clear docs. It's hard to express how much I value the versioned docs dropdown I've seen in the elixir community (linked below for reference), and the impact that that has had on the community's ability to be welcoming to newcomers. If it's something you're up for, I'd love to help make it happen. Not trying to assert that this should occur before published release or anything, just saying I think it might be nice at some point.

https://hexdocs.pm/elixir/1.10.1/Kernel.html
Screen Shot 2020-05-16 at 12 54 33 PM

I'd like to help with adding tests

We now have a publishing process. The only thing remaining for a release is an improved website. I've opened #496 to track. Tests would be really nice but aren't a blocker for an alpha/beta release. If anyone is interested feel free to go through the folders in packages/@romejs and find a package that looks interesting and write some unit tests. You can find *.test.ts files elsewhere as a reference.

Going to close this since #14 is the only actual blocker.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

josephspurrier picture josephspurrier  路  4Comments

shanewilson picture shanewilson  路  4Comments

Kelbie picture Kelbie  路  4Comments

shirshak55 picture shirshak55  路  3Comments

arslivinski picture arslivinski  路  5Comments