README.md 2.87 KB
Newer Older
Christopher Guindon's avatar
Christopher Guindon committed
1
2
3
4
# osgi.org

The [https://www.osgi.org](https://www.osgi.org) website is generated with [Hugo](https://gohugo.io/documentation/).

Christopher Guindon's avatar
Christopher Guindon committed
5
The OSGi WG is a worldwide consortium of technology innovators that advances a proven and mature process to create open specifications that enable the modular assembly of software built with Java technology. Modularity reduces software complexity; OSGi is the best model to modularize Java.
Christopher Guindon's avatar
Christopher Guindon committed
6

Christopher Guindon's avatar
Christopher Guindon committed
7
[![Build Status](https://foundation.eclipse.org/ci/webdev/buildStatus/icon?job=public%2Fosgi.org%2Fmain)](https://foundation.eclipse.org/ci/webdev/job/public/job/osgi.org/job/main/)
Christopher Guindon's avatar
Christopher Guindon committed
8
9
10
11
12
13

## Getting started

Install dependencies, build assets and start a webserver:

```bash
14
yarn && hugo server
Christopher Guindon's avatar
Christopher Guindon committed
15
16
```

17
You can find guidance on the page-level metadata [here](https://eclipsefdn-hugo-solstice-theme.netlify.app/), and examples of the assorted page types (components) [here](https://eclipsefdn-hugo-solstice-theme.netlify.app/components/).
Christopher Guindon's avatar
Christopher Guindon committed
18
19
20

## Contributing

Christopher Guindon's avatar
Christopher Guindon committed
21
22
1. [Fork](https://docs.gitlab.com/ee/user/project/repository/forking_workflow.html) the [osgi.org](https://gitlab.eclipse.org/eclipsefdn/it/websites/osgi.org) repository
2. Clone repository: `git clone https://gitlab.eclipse.org/[your_eclipsefdn_username]/osgi.org.git`
Christopher Guindon's avatar
Christopher Guindon committed
23
24
25
3. Create your feature branch: `git checkout -b my-new-feature`
4. Commit your changes: `git commit -m 'Add some feature' -s`
5. Push feature branch: `git push origin my-new-feature`
Christopher Guindon's avatar
Christopher Guindon committed
26
6. Submit a merge request
Christopher Guindon's avatar
Christopher Guindon committed
27
28
29
30
31

### Declared Project Licenses

This program and the accompanying materials are made available under the terms
of the Eclipse Public License v. 2.0 which is available at
32
<https://www.eclipse.org/legal/epl-2.0>.
Christopher Guindon's avatar
Christopher Guindon committed
33
34
35
36
37

SPDX-License-Identifier: EPL-2.0

## Related projects

Christopher Guindon's avatar
Christopher Guindon committed
38
### [EclipseFdn/solstice-assets](https://gitlab.eclipse.org/eclipsefdn/it/webdev/solstice-assets)
Christopher Guindon's avatar
Christopher Guindon committed
39
40
41

Images, less and JavaScript files for the Eclipse Foundation look and feel.

Christopher Guindon's avatar
Christopher Guindon committed
42
### [EclipseFdn/hugo-solstice-theme](https://gitlab.eclipse.org/eclipsefdn/it/webdev/hugo-solstice-theme/)
Christopher Guindon's avatar
Christopher Guindon committed
43

Christopher Guindon's avatar
Christopher Guindon committed
44
Hugo theme of the Eclipse Foundation look and feel. 
Christopher Guindon's avatar
Christopher Guindon committed
45
46
47

## Bugs and feature requests

Christopher Guindon's avatar
Christopher Guindon committed
48
Have a bug or a feature request? Please search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://gitlab.eclipse.org/eclipsefdn/it/websites/osgi.org/-/issues).
Christopher Guindon's avatar
Christopher Guindon committed
49
50
51
52
53
54
55
56
57
58

## Author

**Christopher Guindon (Eclipse Foundation)**

- <https://twitter.com/chrisguindon>
- <https://github.com/chrisguindon>

## Trademarks

59
60
- Eclipse® is a Trademark of the Eclipse Foundation, Inc.
- Eclipse Foundation is a Trademark of the Eclipse Foundation, Inc.
Christopher Guindon's avatar
Christopher Guindon committed
61
62
63

## Copyright and license

Christopher Guindon's avatar
Christopher Guindon committed
64
Copyright 2021-2022 the [Eclipse Foundation, Inc.](https://www.eclipse.org) and the [osgi.org authors](https://gitlab.eclipse.org/eclipsefdn/it/websites/osgi.org/-/graphs/master). Code released under the [Eclipse Public License Version 2.0 (EPL-2.0)](https://gitlab.eclipse.org/eclipsefdn/it/websites/osgi.org/-/raw/master/README.md).