Skip to content

Commit

Permalink
Convert site to markdown
Browse files Browse the repository at this point in the history
Build with m-site-p

This closes #152
  • Loading branch information
kwin committed Sep 11, 2024
1 parent b848262 commit 4e7fb78
Show file tree
Hide file tree
Showing 341 changed files with 1,170 additions and 143,590 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ One of the committers will take a look and provide feedback or merge your contri

That's it, thanks for contributing to Sisu!

[ECA]: https://www.eclipse.org/legal/ECA.php
[issue-tracker]: https://github.com/eclipse/sisu.inject/issues
[ECA]: https://www.eclipse.org/legal/eca/
[issue-tracker]: https://github.com/eclipse-sisu/sisu-project/issues
[style-guide]: https://maven.apache.org/developers/conventions/code.html
[rebase]: https://github.com/edx/edx-platform/wiki/How-to-Rebase-a-Pull-Request
[github-issue]: https://help.github.com/articles/closing-issues-via-commit-messages/
Expand Down
48 changes: 5 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,57 +12,19 @@
[![maintainability](https://sonarcloud.io/api/project_badges/measure?project=eclipse-sisu_sisu.inject&metric=sqale_rating)](https://sonarcloud.io/summary/overall?id=eclipse-sisu_sisu.inject)
[![license](https://img.shields.io/badge/license-EPL_1.0-blue.svg)](https://www.eclipse.org/legal/epl-v10.html)

Sisu is a modular [JSR330](https://javax-inject.github.io/javax-inject/)-based container that supports classpath scanning, auto-binding, and dynamic auto-wiring.
Sisu is a modular [JSR-330](https://javax-inject.github.io/javax-inject/)-based container that supports classpath scanning, auto-binding, and dynamic auto-wiring.

Sisu uses [Google-Guice](https://github.com/google/guice) to perform dependency injection and provide the core JSR330 support, but removes the need to write explicit bindings in Guice modules. Integration with other containers via the Eclipse Extension Registry and the OSGi Service Registry is a goal of this project.

## Maven

```xml
<dependency>
<groupId>org.eclipse.sisu</groupId>
<artifactId>org.eclipse.sisu.inject</artifactId>
<version>0.3.5</version>
</dependency>
```
Sisu uses [Google Guice](https://github.com/google/guice) to perform dependency injection and provide the core JSR-330 support, but removes the need to write explicit bindings in Guice modules. Integration with other containers via the Eclipse Extension Registry and the OSGi Service Registry is a goal of this project.

## Documentation

[Sisu in 5 minutes](https://eclipse.github.io/sisu.inject/)

[Javadoc](https://eclipse.github.io/sisu.inject/apidocs/)

### Generation of Named Index

Often Sisu's `SpaceModule` doesn't scan the full classpath at run time (for relevant annotations) but relies on a pre-generated index at `META-INF/sisu/javax.inject.Named`. There are two different ways how to create such an index file:

1. By leveraging the Java annotation processor in [org.eclipse.sisu.space.SisuIndexAPT6](https://github.com/eclipse/sisu.inject/blob/master/org.eclipse.sisu.inject/src/main/java/org/eclipse/sisu/space/SisuIndexAPT6.java) to generate the index. One needs to enable via [`javac -processor org.eclipse.sisu.space.SisuIndexAPT6`](https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#annotation-processing) or with the according [`maven-compiler-plugin` parameter `annotationProcessors`](https://maven.apache.org/plugins/maven-compiler-plugin/compile-mojo.html#annotationProcessors).
2. By leveraging the dedicated Maven plugin <https://github.com/eclipse/sisu.mojos/>

## Related projects

https://github.com/eclipse/sisu.mojos/
* a [Maven](https://maven.apache.org/) plugin that generates annotation indexes for Sisu to avoid classpath scanning at runtime

https://github.com/eclipse/sisu.plexus/
* an extension that implements [Plexus](https://codehaus-plexus.github.io/#Plexus_History) container API and injection semantics on top of Sisu
* [Sisu Website](https://eclipse.github.io/sisu.inject/) (soon also available on <https://eclipse.dev/sisu/>)
* [Eclipse Project Information](https://projects.eclipse.org/projects/technology.sisu)

## How to Contribute

We accept contributions via GitHub pull requests. Please see [How To Contribute](CONTRIBUTING.md) to get started.

## License

- [Eclipse Public License, v1.0](https://www.eclipse.org/legal/epl-v10.html)

## Meaning of sisu
<sub>From https://en.wikipedia.org/w/index.php?title=Sisu&oldid=371994592</sub>

> Sisu is a Finnish term loosely translated into English as strength of will, determination, perseverance, and acting rationally in the face of adversity. However, the word is widely considered to lack a proper translation into any language. Sisu has been described as being integral to understanding Finnish culture. The literal meaning is equivalent in English to "having guts", and the word derives from sisus, which means something inner or interior. However sisu is defined by a long-term element in it; it is not momentary courage, but the ability to sustain an action against the odds. Deciding on a course of action and the sticking to that decision against repeated failures is sisu. It is similar to equanimity, except the forbearance of sisu has a grimmer quality of stress management than the latter. The noun sisu is related to the adjective sisukas, one having the quality of sisu.
## Additional information

* Project Website: https://www.eclipse.org/sisu
* Mailing Lists: https://dev.eclipse.org/mailman/listinfo/sisu-dev
* Eclipse PMI: https://projects.eclipse.org/projects/technology.sisu

- [Eclipse Public License, v2.0](https://www.eclipse.org/legal/epl-v20.html)
10 changes: 7 additions & 3 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Releasing Sisu

## Eclipse Foundation Release Policy

<https://www.eclipse.org/projects/handbook/#release>

## Maven

Note: Build uses latest `maven-gpg-plugin` and is getting rid "old bad practices" of storing sensitive information in
Expand All @@ -11,16 +15,16 @@ See [maven-gpg-plugin site](https://maven.apache.org/plugins/maven-gpg-plugin/us

### Release steps

Prerequsites:
**Prerequisites:**
* deploy snapshot: `mvn deploy -P sisu-release` for testing
* make sure source code does not have `@since TBD`; of have, search/replace it with upcoming version
* perform the release

The "usual" Maven release:
* `mvn release:prepare`
* `mvn release:perform`
* project uses https://oss.sonatype.org/ to stage (manual step: close and release staging repository)
* project uses <https://oss.sonatype.org/> to stage (manual step: close and release staging repository)

## Site

TBD
Look at https://eclipse.dev/sisu/development.html#Site_Publishing
Empty file removed docs/.nojekyll
Empty file.
59 changes: 0 additions & 59 deletions docs/apidocs/assets/customizations.css

This file was deleted.

Empty file.
Loading

0 comments on commit 4e7fb78

Please sign in to comment.