Skip to content
Snippets Groups Projects
Commit 96ac6fbb authored by Martin Lowe's avatar Martin Lowe :flag_ca:
Browse files

Update project resources/metadata, remove unneeded dockerfiles

parent c3efbd6d
No related branches found
No related tags found
1 merge request!1Basic example of hosting API specs
Pipeline #14018 passed
...@@ -4,6 +4,6 @@ ...@@ -4,6 +4,6 @@
/tmp /tmp
/static /static
/bin/ /bin/
/content/*/** /content/**
/public /public
/data /data
\ No newline at end of file
# 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-api-spec-host
Thanks for your interest in this project.
## Project description
* https://gitlab.eclipse.org/eclipsefdn/it/webdev/eclipsefdn-api-spec-host
## Developer resources
The project maintains the following source code repositories
* https://gitlab.eclipse.org/eclipsefdn/it/api/eclipsefdn-api-spec-host
## 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.
FROM nginx:latest
COPY ./static /usr/share/nginx/html
\ No newline at end of file
setup:; setup:;
yarn install --frozen-lockfile yarn install --frozen-lockfile
clean:; clean:;
rm -rf static
rm -rf tmp rm -rf tmp
build: setup clean; build: setup clean;
sh fetch.sh sh fetch.sh
run-local: build run-nobuild; run-local: build run-nobuild;
run-nobuild:; hugo server
docker compose up -d \ No newline at end of file
\ No newline at end of file
# Notices for eclipsefdn-api-spec-host
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/webdev/eclipsefdn-api-spec-host
## 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/webdev/eclipsefdn-api-spec-host
# eclipsefdn-api-spec-host # eclipsefdn-api-spec-host
## Compiling locally
To cold start this spec host to run locally, there is a make command available that will clean and fetch all required data and packages before running hugo server in line to start the server locally. This will bind hugo by default to port 1313 and make the site available at [http://localhost:1313/docs/api](http://localhost:1313/docs/api).
## Getting started
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
## Add your files
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
``` ```
cd existing_repo make run-local
git remote add origin https://gitlab.eclipse.org/eclipsefdn/it/webdev/eclipsefdn-api-spec-host.git
git branch -M main
git push -uf origin main
``` ```
## Integrate with your tools ## Adding new specs
- [ ] [Set up project integrations](https://gitlab.eclipse.org/eclipsefdn/it/webdev/eclipsefdn-api-spec-host/-/settings/integrations)
## Collaborate with your team
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
## Test and Deploy
Use the built-in continuous integration in GitLab.
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
*** To add new specs to the rendered site, a new line can be added in the `repos.properties` file. The key of the property is the display name to use in the URL and site generation, and the value of the property is the URL at which the spec can be found. Once added, re-running the make command above should allow for previews of the updated specification list.
# Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
## Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
## Name
Choose a self-explaining name for your project.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing ## Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. 1. [Fork](https://docs.gitlab.com/ee/user/project/repository/forking_workflow.html) the [eclipsefdn-api-spec-host](https://gitlab.eclipse.org/eclipsefdn/it/webdev/eclipsefdn-api-spec-host) repository
2. Clone repository `git clone https://gitlab.eclipse.org/[your_eclipsefdn_username]/eclipsefdn-api-spec-host.git`
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`
6. Submit a merge request
## Authors and acknowledgment ### Declared Project Licenses
Show your appreciation to those who have contributed to the project.
## License This program and the accompanying materials are made available under the terms
For open source projects, say how it is licensed. of the Eclipse Public License v. 2.0 which is available at
http://www.eclipse.org/legal/epl-2.0.
## Project status SPDX-License-Identifier: EPL-2.0
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
...@@ -5,15 +5,11 @@ theme = "eclipsefdn-hugo-solstice-theme" ...@@ -5,15 +5,11 @@ theme = "eclipsefdn-hugo-solstice-theme"
metaDataFormat = "yaml" metaDataFormat = "yaml"
disableKinds = [] disableKinds = []
themesDir = "node_modules/" themesDir = "node_modules/"
enableRobotsTXT = true enableRobotsTXT = false
pluralizeListTitles = false
[Params] [Params]
google_tag_manager = "GTM-5WLCZXC"
description = "Business-friendly open source and open innovation underpins exploitation, community building and dissemination strategy for European projects." description = "Business-friendly open source and open innovation underpins exploitation, community building and dissemination strategy for European projects."
seo_title_suffix = " | The Eclipse Foundation" seo_title_suffix = " | The Eclipse Foundation"
#styles = "css/styles.css"
#js = "js/solstice.js"
logo_width = "130" logo_width = "130"
header_left_classes = "col-sm-10 margin-top-10" header_left_classes = "col-sm-10 margin-top-10"
main_menu_wrapper_classes = "col-sm-14 margin-top-10" main_menu_wrapper_classes = "col-sm-14 margin-top-10"
...@@ -25,4 +21,4 @@ pluralizeListTitles = false ...@@ -25,4 +21,4 @@ pluralizeListTitles = false
facebook = "eclipse.org" facebook = "eclipse.org"
twitter = "EclipseFdn" twitter = "EclipseFdn"
youtube = "EclipseFdn" youtube = "EclipseFdn"
linkedin = "company/eclipse-foundation/" linkedin = "company/eclipse-foundation/"
\ No newline at end of file
...@@ -2,12 +2,10 @@ ...@@ -2,12 +2,10 @@
name = "Members" name = "Members"
url = "https://www.eclipse.org/membership/" url = "https://www.eclipse.org/membership/"
weight = 1 weight = 1
[[main]] [[main]]
name = "Working Groups" name = "Working Groups"
url = "https://www.eclipse.org/org/workinggroups/" url = "https://www.eclipse.org/org/workinggroups/"
weight = 2 weight = 2
[[main]] [[main]]
name = "Projects" name = "Projects"
url = "https://www.eclipse.org/projects/" url = "https://www.eclipse.org/projects/"
......
version: '3'
services:
www:
build:
context: .
dockerfile: ./Dockerfile
image: eclipsefdn/api-spec-host:latest
ports:
- 8080:80
\ No newline at end of file
<ul> <ul>
{{ range .Site.Data.specs.items }} {{ range sort .Site.Data.specs.items }}
<li> <li>
<a href="{{ . | relURL }}">{{ . }}</a> <a href="{{ . | relURL }}">{{ . }}</a>
</li> </li>
......
eclipsefdn-downloads-api=https://gitlab.eclipse.org/eclipsefdn/it/api/eclipsefdn-downloads-api/-/raw/main/spec/openapi.yaml eclipsefdn-downloads-api=https://gitlab.eclipse.org/eclipsefdn/it/api/eclipsefdn-downloads-api/-/raw/main/spec/openapi.yaml
eclipsefdn-mailing-lists-api=https://gitlab.eclipse.org/eclipsefdn/it/api/eclipsefdn-mailing-lists-api/-/raw/main/spec/openapi.yaml eclipsefdn-mailing-lists-api=https://gitlab.eclipse.org/eclipsefdn/it/api/eclipsefdn-mailing-lists-api/-/raw/main/spec/openapi.yaml
eclipsefdn-cve-api=https://gitlab.eclipse.org/eclipsefdn/it/api/eclipsefdn-cve-api/-/raw/main/spec/openapi.yaml
eclipsefdn-working-groups-api=https://gitlab.eclipse.org/eclipsefdn/it/api/eclipsefdn-working-groups-api/-/raw/main/spec/openapi.yaml
eclipsefdn-media-link-api=https://gitlab.eclipse.org/eclipsefdn/it/api/eclipsefdn-media-link-api/-/raw/master/spec/openapi.yaml
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment