Skip to content

GradleUp site #1

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

Merged
merged 23 commits into from
Jul 28, 2024
Merged

GradleUp site #1

merged 23 commits into from
Jul 28, 2024

Conversation

oleg-nenashev
Copy link
Contributor

@oleg-nenashev oleg-nenashev commented Jul 19, 2024

Started a very basic prototype of the website, based on the Material for Mkdocs and the template. I have not yet updated graphics and styles, so it does not look very great

Preview

https://oleg-nenashev.github.io/gradleup.github.io/

Initial Content

  • Project pages, included from the repositories
  • Implement proper styles for the site
  • Proper logo
  • Better landing page
  • Guidelines for joining the community channels


## Contact the Team

For now, use DMs on the Kotlin Foundation or the Gradle Community Slack.
Copy link
Member

Choose a reason for hiding this comment

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

Would be cool to have a public #gradleup on the Gradle slack

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We can create one once we get the trademark usage grant. But yes, this is my assumption too

@oleg-nenashev oleg-nenashev marked this pull request as ready for review July 20, 2024 12:29
@oleg-nenashev oleg-nenashev added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 20, 2024
@oleg-nenashev oleg-nenashev requested review from a team and martinbonnin July 20, 2024 12:54
@@ -1 +0,0 @@
www.gradleup.com
Copy link
Member

Choose a reason for hiding this comment

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

Was that needed for DNS verification maybe? Ping @deepy ?

Copy link
Member

Choose a reason for hiding this comment

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

Yeah we need to re-add it before/after merge, it's used by GH to map the pages to the domain
We don't need to worry about the verification as the domain is verified by the GH organization, but I think it's omitted here to make the preview easier

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It is no longer needed for modern GitHub Pages. It was a culprit for static sites long ago

Comment on lines 22 to 23
[OSI-approved open source licenses](https://opensource.org/),
preferably the Apache License v2.
Copy link
Member

Choose a reason for hiding this comment

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

Out of curiosity, any reason to prefer Apache vs MIT?

Copy link
Member

Choose a reason for hiding this comment

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

My personal preference is always MIT or BSD, but Apache v2's patent grant is supposedly very useful for safeguarding against legal actions

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yep, Apache License prevents from patent claims. Will remove the specifics for now though

Comment on lines 7 to 26
## Tools for Android

- [Auto Manifest](../auto-manifest/README.md) -
Generates `AndroidManifest.xml` in simple libraries so that you don't have to
- [Gradle static analysis plugin](../static-analysis-plugin/README.md) -
A Gradle plugin to easily apply the same setup of static analysis tools
across different Android, Java or Kotlin projects.
- [Gr8](../gr8/README.md) -
Gr8 makes it easy to shadow, shrink, and minimize your jars.

## Gradle DevX

- [Gratatouille](../gratatouille/README.md) -
Gratatouille is an opinionated framework to build Gradle plugins. Write pure Kotlin functions and the Gratatouille KSP processor generates tasks, workers and wiring code for you.
- [NMCP](../nmcp/README.md) (New Maven Central Publishing) -
A plugin that uses the new Central Portal publisher API to publish to Maven Central.
- [Librarian](../librarian/README.md) -
Librarian is a library to help building Kotlin libraries.
- [Maven Sympathy](../maven-sympathy/README.md) -
A small Gradle plugin that checks that your project dependencies play nice with Maven resolution strategy
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure I get the distinction between Android and Gradle DevX.

You can use GR8 to shrink/relocate any jar, not only Android for an example. Maybe make a single flat list?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For me it seemed to be too big for a single list. But yes, you are right, right now the classification is not very helpful. I will remove it, we can always restore it or do another one in the future

Copy link
Member

@deepy deepy left a comment

Choose a reason for hiding this comment

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

Looks good to me, though the contrast in the footer on the landing page is too low - but that's not a blocker and can be adjusted afterwards

@cortinico
Copy link

Looks good to me, though the contrast in the footer on the landing page is too low - but that's not a blocker and can be adjusted afterwards

I had the same feeling that the palette needs to be tweaked a bit as the contrast between title and background in dark mode is not really high

Copy link

@cortinico cortinico left a comment

Choose a reason for hiding this comment

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

Amazing work!

mkdocs.yml Outdated
- Gr8: gr8/README.md
- Gradle DevX:
- Gratatouille: gratatouille/README.md
- NMCP (New Maven Central Publishing): nmcp/README.md

Choose a reason for hiding this comment

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

more of a nit:

The readme title reads a bit odd to me: Nmcp: New Maven Central Publishing (or New Maven Central Portal too!). I think we should be mindful of the README files of the various projects as they will end up on the website.

Also status badges/emojis are all in different places.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, updating the downstream READMEs is definitely advised

oleg-nenashev and others added 3 commits July 28, 2024 07:23
Co-authored-by: Martin Bonnin <martin@mbonnin.net>
Co-authored-by: Alex Nordlund <deep.alexander@gmail.com>
@oleg-nenashev
Copy link
Contributor Author

Will merge as agreed on Slack

@oleg-nenashev oleg-nenashev merged commit ba9ab45 into GradleUp:master Jul 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants