diff --git a/.github/workflows/link-checker.yml b/.github/workflows/link-checker.yml new file mode 100644 index 0000000..5e6fd39 --- /dev/null +++ b/.github/workflows/link-checker.yml @@ -0,0 +1,24 @@ +name: Link Checker +on: + push: + branches: [ main ] + pull_request: + branches: [ main ] + +jobs: + linkchecker: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + - name: lychee Link Checker + id: lychee + uses: lycheeverse/lychee-action@master + with: + args: --accept=200,403,429 "**/*.html" "**/*.md" "**/*.txt" + env: + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} + - name: Fail if there were link errors + run: exit ${{ steps.lychee.outputs.exit_code }} + diff --git a/.github/workflows/release-workflow.yml b/.github/workflows/release-workflow.yml index a933a5e..9dc5842 100644 --- a/.github/workflows/release-workflow.yml +++ b/.github/workflows/release-workflow.yml @@ -7,7 +7,7 @@ on: - 'v*' env: - PLUGIN_NAME: ganttChartDashboards + PLUGIN_NAME: gantt-chart-dashboards OPENSEARCH_VERSION: '1.0' OPENSEARCH_PLUGIN_VERSION: 1.0.0.0-rc1 diff --git a/.github/workflows/test-and-build-workflow.yml b/.github/workflows/test-and-build-workflow.yml index ac5dd84..ef93118 100644 --- a/.github/workflows/test-and-build-workflow.yml +++ b/.github/workflows/test-and-build-workflow.yml @@ -4,7 +4,7 @@ name: Test and Build Gantt Chart on: [pull_request, push] env: - PLUGIN_NAME: ganttChartDashboards + PLUGIN_NAME: gantt-chart-dashboards OPENSEARCH_VERSION: '1.0' OPENSEARCH_PLUGIN_VERSION: 1.0.0.0-rc1 diff --git a/ADMINS.md b/ADMINS.md new file mode 100644 index 0000000..81f320c --- /dev/null +++ b/ADMINS.md @@ -0,0 +1,7 @@ +## Admins + +| Admin | GitHub ID | Affiliation | +| --------------- | --------------------------------------- | ----------- | +| Henri Yandell | [hyandell](https://github.com/hyandell) | Amazon | + +[This document](https://github.com/opensearch-project/.github/blob/main/ADMINS.md) explains what admins do in this repo. and how they should be doing it. If you're interested in becoming a maintainer, see [MAINTAINERS](MAINTAINERS.md). If you're interested in contributing, see [CONTRIBUTING](CONTRIBUTING.md). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0859dbe..1f1b6c4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,96 +1,4 @@ -# Contributing Guidelines +## Contributing to this Project -Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional -documentation, we greatly value feedback and contributions from our community. - -Please read through this document before submitting any issues or pull requests to ensure we have all the necessary -information to effectively respond to your bug report or contribution. - - -## Reporting Bugs/Feature Requests - -We welcome you to use the GitHub issue tracker to report bugs or suggest features. - -When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already -reported the issue. Please try to include as much information as you can. Details like these are incredibly useful: - -* A reproducible test case or series of steps -* The version of our code being used -* Any modifications you've made relevant to the bug -* Anything unusual about your environment or deployment - -## Sign your work -The sign-off is a simple line at the end of each commit, which certifies that you wrote it or otherwise have the right to pass it on as an open-source patch. if you can certify the below -``` -By making a contribution to this project, I certify that: -(a) The contribution was created in whole or in part by me and I -have the right to submit it under the open source license -indicated in the file; or -(b) The contribution is based upon previous work that, to the best -of my knowledge, is covered under an appropriate open source -license and I have the right under that license to submit that -work with modifications, whether created in whole or in part -by me, under the same open source license (unless I am -permitted to submit under a different license), as indicated -in the file; or -(c) The contribution was provided directly to me by some other -person who certified (a), (b) or (c) and I have not modified -it. -(d) I understand and agree that this project and the contribution -are public and that a record of the contribution (including all -personal information I submit with it, including my sign-off) is -maintained indefinitely and may be redistributed consistent with -this project or the open source license(s) involved. -``` -then you just add a line to every git commit message: -``` -Signed-off-by: Bob Sanders -``` -You can sign off your work easily by adding the configuration in github -``` -git config user.name "Bob Sanders" -git config user.email "bob.sanders@email.com" -``` -Then, you could sign off commits automatically by adding `-s` or `-=signoff` parameter to your usual git commits commands. e.g. -``` -git commit -s -m "my first commit" -``` - - -## Contributing via Pull Requests -Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that: - -1. You are working against the latest source on the *main* branch. -2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already. -3. You open an issue to discuss any significant work - we would hate for your time to be wasted. - -To send us a pull request, please: - -1. Fork the repository. -2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change. -3. Ensure local tests pass. -4. Commit to your fork using clear commit messages. -5. Send us a pull request, answering any default questions in the pull request interface. -6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation. - -GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and -[creating a pull request](https://help.github.com/articles/creating-a-pull-request/). - - -## Finding contributions to work on -Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start. - - -## Code of Conduct -This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). -For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact -opensource-codeofconduct@amazon.com with any additional questions or comments. - - -## Security issue notifications -If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue. - - -## Licensing - -See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution. +OpenSearch is a community project that is built and maintained by people just like **you**. +[This document](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md) explains how you can contribute to this and related projects. diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md new file mode 100644 index 0000000..8e376b5 --- /dev/null +++ b/DEVELOPER_GUIDE.md @@ -0,0 +1,52 @@ +## Developer Guide + +So you want to contribute code to this project? Excellent! We're glad you're here. Here's what you need to do. + +### Setup + +1. Download OpenSearch for the version that matches the [OpenSearch Dashboards version specified in package.json](./package.json#L5). +1. Download the OpenSearch Dashboards source code for the [version specified in package.json](./package.json#L5) you want to set up. + +1. Change your node version to the version specified in `.node-version` inside the OpenSearch Dashboards root directory. +1. cd into the OpenSearch Dashboards source code directory. +1. Check out this package from version control into the `plugins` directory. +``` +rm plugins -r +git clone git@github.com:opensearch-project/dashboards-visualizations.git plugins --no-checkout +cd plugins +echo 'gantt-chart/*' >> .git/info/sparse-checkout +git config core.sparseCheckout true +git checkout main +``` +6. Run `yarn osd bootstrap` inside `OpenSearch-Dashboards` directory. + +Ultimately, your directory structure should look like this: + +```md +. +├── OpenSearch Dashboards +│ └── plugins +│ └── gantt-chart +``` + + +### Build + +To build the plugin's distributable zip simply run `yarn build`. + +Example output: `./build/gantt-chart-dashboards*.zip` + + +### Run + +- `yarn start` + + Starts OpenSearch Dashboards and includes this plugin. OpenSearch Dashboards will be available on `localhost:5601`. + +- `npx cypress run` + + Runs the plugin cypress tests. + +### Submitting Changes + +See [CONTRIBUTING](CONTRIBUTING.md). diff --git a/README.md b/README.md index 0f2a3cf..f3b147a 100644 --- a/README.md +++ b/README.md @@ -5,68 +5,30 @@ The OpenSearch Dashboards Visualizations enables you to use additional types of ## Documentation -Please see our technical [documentation](https://docs-beta.opensearch.org/docs/opensearch-dashboards/gantt/) to learn more about its features. +Please see our technical [documentation](https://docs-beta.opensearch.org/dashboards/gantt/) to learn more about its features. +## Contributing -## Setup +See [developer guide](DEVELOPER_GUIDE.md) and [how to contribute to this project](CONTRIBUTING.md). -1. Download OpenSearch for the version that matches the [OpenSearch Dashboards version specified in package.json](./package.json#L5). -1. Download the OpenSearch Dashboards source code for the [version specified in package.json](./package.json#L5) you want to set up. +## Getting Help -1. Change your node version to the version specified in `.node-version` inside the OpenSearch Dashboards root directory. -1. cd into the OpenSearch Dashboards source code directory. -1. Check out this package from version control into the `plugins` directory. -``` -rm plugins -r -git clone git@github.com:opensearch-project/dashboards-visualizations.git plugins --no-checkout -cd plugins -echo 'gantt-chart/*' >> .git/info/sparse-checkout -git config core.sparseCheckout true -git checkout main -``` -6. Run `yarn osd bootstrap` inside `OpenSearch-Dashboards` directory. +If you find a bug, or have a feature request, please don't hesitate to open an issue in this repository. -Ultimately, your directory structure should look like this: +For more information, see [project website](https://opensearch.org/) and [documentation](https://docs-beta.opensearch.org/). If you need help and are unsure where to open an issue, try [forums](https://discuss.opendistrocommunity.dev/). -```md -. -├── OpenSearch Dashboards -│ └── plugins -│ └── gantt-chart -``` +## Code of Conduct +This project has adopted the [Amazon Open Source Code of Conduct](CODE_OF_CONDUCT.md). For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq), or contact [opensource-codeofconduct@amazon.com](mailto:opensource-codeofconduct@amazon.com) with any additional questions or comments. -## Build +## Security -To build the plugin's distributable zip simply run `yarn build`. - -Example output: `./build/ganttchartDashboards*.zip` - - -## Run - -- `yarn start` - - Starts OpenSearch Dashboards and includes this plugin. OpenSearch Dashboards will be available on `localhost:5601`. - -- `npx cypress run` - - Runs the plugin cypress tests. - - -## Contributing to OpenSearch Dashboards Visualizations - -We welcome you to get involved in development, documentation, testing the visualizations plugin. See our [CONTRIBUTING.md](./CONTRIBUTING.md) and join in. - -## Bugs, Enhancements or Questions - -Please file an issue to report any bugs you may find, enhancements you may need or questions you may have [here](https://github.com/opensearch-project/dashboards-visualizations/issues). +If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public GitHub issue. ## License -This code is licensed under the Apache 2.0 License. +This project is licensed under the [Apache v2.0 License](LICENSE.txt). ## Copyright -Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. - +Copyright 2020-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. diff --git a/RELEASING.md b/RELEASING.md new file mode 100644 index 0000000..91263ac --- /dev/null +++ b/RELEASING.md @@ -0,0 +1 @@ +This project follows the [OpenSearch release process](https://github.com/opensearch-project/.github/blob/main/RELEASING.md). diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..b862921 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,3 @@ +## Reporting a Vulnerability + +If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/) or directly via email to aws-security@amazon.com. Please do **not** create a public GitHub issue.