Commit 5506124c authored by Martin Lowe's avatar Martin Lowe 🇨🇦
Browse files

Update documentation and meta files for the project

parent d8b75fb2
......@@ -82,3 +82,4 @@ docker.secret.properties
/.apt_generated/
/.apt_generated_tests/
src/test/resources/schemas
result.json
# Community Code of Conduct
Version 1.2
August 19, 2020
##Our Pledge
In the interest of fostering an open and welcoming environment, we as community members, contributors, committers, and project leaders pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting
## Our Responsibilities
With the support of the Eclipse Foundation staff (the “Staff”), project committers and leaders are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Project committers and leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
## Scope
This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the Eclipse Foundation project or its community in public spaces. Examples of representing a project or community include posting via an official social media account, or acting as a project representative at an online or offline event. Representation of a project may be further defined and clarified by project committers, leaders, or the EMO.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the Staff at codeofconduct@eclipse.org. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The Staff is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Project committers or leaders who do not follow the Code of Conduct in good faith may face temporary or permanent repercussions as determined by the Staff.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
\ No newline at end of file
# Contributing to eclipsefdn-downloads-api
Thanks for your interest in this project.
## Project description
* https://gitlab.eclipse.org/eclipsefdn/it/api/eclipsefdn-downloads-api
## Developer resources
The project maintains the following source code repositories
* https://gitlab.eclipse.org/eclipsefdn/it/api/eclipsefdn-downloads-api
## Eclipse Contributor Agreement
Before your contribution can be accepted by the project team contributors must
electronically sign the Eclipse Contributor Agreement (ECA).
* http://www.eclipse.org/legal/ECA.php
Commits that are provided by non-committers must have a Signed-off-by field in
the footer indicating that the author is aware of the terms by which the
contribution has been provided to the project. The non-committer must
additionally have an Eclipse Foundation account and must have a signed Eclipse
Contributor Agreement (ECA) on file.
For more information, please see the Eclipse Committer Handbook:
https://www.eclipse.org/projects/handbook/#resources-commit
## Contact
Contact the Eclipse Foundation Webdev team via webdev@eclipse-foundation.org.
This diff is collapsed.
......@@ -14,5 +14,14 @@ compile-start: compile-quick;
docker-compose down
docker-compose build
docker-compose up
compile-start-headless: compile-quick;
docker-compose down
docker-compose build
docker-compose up -d
start-spec: validate-spec;
npm run start
\ No newline at end of file
npm run start
generate-notice-src:;
docker run -v $(PWD)/:/project \
-v /project/node_modules \
-v /project/volumes \
scancode-toolkit -clpeui --json-pp /project/result.json /project
\ No newline at end of file
# Notices for react-eclipsefdn-members
This content is produced and maintained by the Eclipse Foundation. Trademarks are the property of their respective owners.
* Project home: https://gitlab.eclipse.org/eclipsefdn/it/api/eclipsefdn-downloads-api
## Trademarks
* Eclipse® is a Trademark of the Eclipse Foundation, Inc.
* Eclipse Foundation is a Trademark of the Eclipse Foundation, Inc.
## Copyright
All content is the property of the respective authors or their employers. For
more information regarding authorship of content, please consult the listed
source code repository logs.
## 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
http://www.eclipse.org/legal/epl-2.0.
SPDX-License-Identifier: EPL-2.0
## Source Code
The project maintains the following source code repositories:
* https://gitlab.eclipse.org/eclipsefdn/it/api/eclipsefdn-downloads-api
## Third-party Content
### Quarkus
* License: Apache License 2.0 (APL)
### Auto-value
* License: Apache License 2.0 (APL)
### Guava
* License: Apache License 2.0 (APL)
# eclipsefdn-downloads-api
## Starting a development environment
Requirements:
* Docker
* docker-compose
* Java 11 or greater
* mvn
* node.js + npm
Recommended:
* make
Before starting, an environment file should be created to ensure that variables are properly available to the docker-compose instance that will hold the development environment. A copy of the base variables and some sample values are available under `./config/.env.sample`, and a copy for this workspace can be created by copying this file to the project root under the name `.env`. It is recommended that the base values for passwords be updated to ensure better security for the given system.
Once created, a copy of the `sample.secret.properties` file in the `./config` folder should be created in the same folder with the name `secret.properties`. Once created, if the `.env` file was updated from the base, the `quarkus.datasource.password` should be updated to reflect the value for `DOWNLOADS_MYSQL_PASSWORD`.
After both the `.env` and the `./config/secret.properties` files have been created and configured, run either `make compile-start` or `make compile-start-headless`. The first option binds the docker containers to the current terminal, and ends the processes when the terminal is closed. The second option starts the docker containers as part of the daemon and persists beyond the terminal session.
The application can be checked by visiting http://localhost:8090/downloads/release/2022-03. At this address, a return should be visible that represents the 2022-03 release of the Eclipse IDE.
## Updating notice
Notice file contents were authored using the output of the Scancode-toolkit, running against the local environment. Any new packages added to the project should be evaluated before they are added to the project to ensure they are compatible with the EPL-2.0 license that this API is available under. To make use of Scancode, it will need to be [installed for Docker](https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#installation-via-docker), and its recommended that the [Scancode-Workbench](https://github.com/nexB/scancode-workbench) be used to evaluate the results.
\ No newline at end of file
DOWNLOADS_MYSQL_PASSWORD=eclipse_sample
\ No newline at end of file
quarkus.datasource.username = sample
quarkus.datasource.password = sample
quarkus.datasource.username = root
quarkus.datasource.password = eclipse_sample
quarkus.datasource.jdbc.url=jdbc:mariadb://mariadb/eclipse
\ No newline at end of file
......@@ -31,7 +31,7 @@ services:
ports:
- '3306:3306'
environment:
MYSQL_ROOT_PASSWORD: ${REM_MYSQL_PASSWORD}
MYSQL_ROOT_PASSWORD: ${DOWNLOADS_MYSQL_PASSWORD}
MYSQL_DATABASE: eclipse
volumes:
- ./config/mariadb/ddl.sql:/docker-entrypoint-initdb.d/ddl.sql
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment