-
Notifications
You must be signed in to change notification settings - Fork 44
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Migrate gantt chart to OpenSearch Dashboards #1
Changes from 7 commits
9142a31
afda31c
47c123a
f906dca
a6dde16
a87e6f7
90cf7b5
e9a59af
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
--- | ||
name: 🐛 Bug report | ||
about: Create a report to help us improve | ||
title: "[BUG]" | ||
labels: bug | ||
assignees: '' | ||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior: | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Plugins** | ||
Please list all plugins currently enabled. | ||
|
||
**Screenshots** | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
**Host/Environment (please complete the following information):** | ||
- OS: [e.g. iOS] | ||
- Version [e.g. 22] | ||
|
||
**Additional context** | ||
Add any other context about the problem here. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
name: 🎆 Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: enhancement | ||
assignees: '' | ||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -7,8 +7,8 @@ on: | |||||
- 'v*' | ||||||
|
||||||
env: | ||||||
PLUGIN_NAME: opendistroGanttChartKibana | ||||||
OD_VERSION: 1.13.0.0 | ||||||
PLUGIN_NAME: ganttChartDashboards | ||||||
OD_VERSION: 1.15.0.0 | ||||||
|
||||||
jobs: | ||||||
|
||||||
|
@@ -28,13 +28,13 @@ jobs: | |||||
- name: Checkout Plugin | ||||||
uses: actions/checkout@v1 | ||||||
|
||||||
- name: Checkout Kibana | ||||||
- name: Checkout OpenSearch Dashboards | ||||||
uses: actions/checkout@v1 | ||||||
with: | ||||||
repository: opendistro-for-elasticsearch/kibana-oss | ||||||
ref: 7.10.2 | ||||||
token: ${{secrets.OD_ACCESS}} | ||||||
path: kibana-visualizations/kibana | ||||||
path: dashboards-visualizations/OpenSearch-Dashboards | ||||||
|
||||||
- name: Setup Node | ||||||
uses: actions/setup-node@v1 | ||||||
|
@@ -43,27 +43,28 @@ jobs: | |||||
|
||||||
- name: Move Gantt Chart to Plugins Dir | ||||||
run: | | ||||||
mv gantt-chart kibana/plugins | ||||||
mv gantt-chart OpenSearch-Dashboards/plugins | ||||||
|
||||||
- name: Kibana Pluign Bootstrap | ||||||
- name: Pluign Bootstrap | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Super nit
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. thanks! addressed comments |
||||||
run: | | ||||||
cd kibana/plugins/gantt-chart | ||||||
cd OpenSearch-Dashboards/plugins/gantt-chart | ||||||
yarn kbn bootstrap | ||||||
|
||||||
- name: Build Artifact | ||||||
run: | | ||||||
cd kibana/plugins/gantt-chart | ||||||
cd OpenSearch-Dashboards/plugins/gantt-chart | ||||||
yarn build | ||||||
mv ./build/*.zip ./build/${{ env.PLUGIN_NAME }}-${{ env.OD_VERSION }}.zip | ||||||
|
||||||
- name: Upload to S3 | ||||||
run: | | ||||||
cd kibana/plugins/gantt-chart | ||||||
cd OpenSearch-Dashboards/plugins/gantt-chart | ||||||
artifact=`ls ./build/*.zip` | ||||||
|
||||||
# inject build number before the suffix | ||||||
zip_outfile=`basename ${artifact%.zip}-build-${GITHUB_RUN_NUMBER}.zip` | ||||||
|
||||||
# TODO update s3 bucket | ||||||
s3_prefix="s3://staging.artifacts.opendistroforelasticsearch.amazon.com/snapshots/kibana-plugins/gantt-chart/" | ||||||
|
||||||
echo "Copying ${artifact} to ${s3_prefix}${zip_outfile}" | ||||||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,25 @@ | ||
## 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 | ||
[email protected] with any additional questions or comments. | ||
|
||
This code of conduct applies to all spaces provided by the OpenSource project including in code, documentation, issue trackers, mailing lists, chat channels, wikis, blogs, social media and any other communication channels used by the project. | ||
|
||
|
||
**Our open source communities endeavor to:** | ||
|
||
* Be Inclusive: We are committed to being a community where everyone can join and contribute. This means using inclusive and welcoming language. | ||
* Be Welcoming: We are committed to maintaining a safe space for everyone to be able to contribute. | ||
* Be Respectful: We are committed to encouraging differing viewpoints, accepting constructive criticism and work collaboratively towards decisions that help the project grow. Disrespectful and unacceptable behavior will not be tolerated. | ||
* Be Collaborative: We are committed to supporting what is best for our community and users. When we build anything for the benefit of the project, we should document the work we do and communicate to others on how this affects their work. | ||
|
||
|
||
**Our Responsibility. As contributors, members, or bystanders we each individually have the responsibility to behave professionally and respectfully at all times. Disrespectful and unacceptable behaviors include, but are not limited to:** | ||
|
||
* The use of violent threats, abusive, discriminatory, or derogatory language; | ||
* Offensive comments related to gender, gender identity and expression, sexual orientation, disability, mental illness, race, political or religious affiliation; | ||
* Posting of sexually explicit or violent content; | ||
* The use of sexualized language and unwelcome sexual attention or advances; | ||
* Public or private harassment of any kind; | ||
* Publishing private information, such as physical or electronic address, without permission; | ||
* Other conduct which could reasonably be considered inappropriate in a professional setting; | ||
* Advocating for or encouraging any of the above behaviors. | ||
* Enforcement and Reporting Code of Conduct Issues: | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported. [Contact us](mailto:[email protected]). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Dashboards Visualizations Maintainers | ||
|
||
## Maintainers | ||
| Maintainer | GitHub ID | Affiliation | | ||
|------------------------|---------------------------------------------------|-------------| | ||
| Anantha Krishna Bhatta | [akbhatta](https://github.com/akbhatta) | Amazon | | ||
| Anirudha (Ani) Jadhav | [anirudha](https://github.com/anirudha) | Amazon | | ||
| Charlotte | [CEHENKLE](https://github.com/CEHENKLE) | Amazon | | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Also I believe this should just be the folks who are making commits to the repo. It's not just all folks who have write access. As an example: probably Nick and Charlotte are just admins for the team but I do not foresee them making commits or reviewing PRs. The idea of Maintainers.md is to help community to know whom to reachout. Also comment from Dawn helps it clarify: "Typically, the maintainers file would just contain the maintainers for this particular repo. This helps new contributors understand who is likely to merge their PRs and gives them real people to follow up with if there are any issues getting their contributions merged." There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 100% agreed There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. got it, fixed |
||
| David Cui | [davidcui-amzn](https://github.com/davidcui-amzn) | Amazon | | ||
| Joshua Li | [joshuali925](https://github.com/joshuali925) | Amazon | | ||
| Nick Knize | [nknize](https://github.com/nknize) | Amazon | |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,12 @@ | ||
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
OpenSearch | ||
Copyright 2021 OpenSearch Contributors | ||
|
||
This product includes software developed by | ||
Elasticsearch (http://www.elastic.co). | ||
Copyright 2009-2018 Elasticsearch | ||
|
||
This product includes software developed by The Apache Software | ||
Foundation (http://www.apache.org/). | ||
|
||
This product includes software developed by | ||
Joda.org (http://www.joda.org/). |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,38 +1,36 @@ | ||
# Open Distro for Elasticsearch Kibana Visualizations | ||
# OpenSearch Dashboards Visualizations | ||
|
||
The Open Distro for Elasticsearch Kibana Visualizations enables you to use additional types of visualizations inside Kibana Visualize and integrate them in Kibana Dashboard. | ||
The OpenSearch Dashboards Visualizations enables you to use additional types of visualizations inside OpenSearch Dashboards Visualize and integrate them in Dashboard. | ||
|
||
|
||
## Documentation | ||
|
||
Please see our technical [documentation](https://opendistro.github.io/for-elasticsearch-docs/) to learn more about its features. | ||
Please see our technical [documentation](https://opendistro.github.io/for-elasticsearch-docs/docs/kibana/gantt/) to learn more about its features. | ||
|
||
|
||
## Setup | ||
|
||
1. Download Elasticsearch for the version that matches the [Kibana version specified in package.json](./package.json#L5). | ||
1. Download the Kibana source code for the [version specified in package.json](./package.json#L5) you want to set up. | ||
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. | ||
|
||
See the [Kibana contributing guide](https://github.com/elastic/kibana/blob/master/CONTRIBUTING.md#setting-up-your-development-environment) for more instructions on setting up your development environment. | ||
|
||
1. Change your node version to the version specified in `.node-version` inside the Kibana root directory. | ||
1. cd into the Kibana source code directory. | ||
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 [email protected]:opendistro-for-elasticsearch/kibana-visualizations.git plugins --no-checkout | ||
git clone [email protected]: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 kbn bootstrap` inside `kibana` directory. | ||
6. Run `yarn osd bootstrap` inside `OpenSearch-Dashboards` directory. | ||
|
||
Ultimately, your directory structure should look like this: | ||
|
||
```md | ||
. | ||
├── kibana | ||
├── OpenSearch Dashboards | ||
│ └── plugins | ||
│ └── gantt-chart | ||
``` | ||
|
@@ -42,29 +40,27 @@ Ultimately, your directory structure should look like this: | |
|
||
To build the plugin's distributable zip simply run `yarn build`. | ||
|
||
Example output: `./build/opendistroGanttChartKibana-*.zip` | ||
Example output: `./build/opendistroGanttChart*.zip` | ||
|
||
|
||
## Run | ||
|
||
- `yarn start` | ||
|
||
Starts Kibana and includes this plugin. Kibana will be available on `localhost:5601`. | ||
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 Open Distro for Elasticsearch Kibana Visualizations | ||
## Contributing to OpenSearch Dashboards Visualizations | ||
|
||
We welcome you to get involved in development, documentation, testing the kibana reports plugin. See our [CONTRIBUTING.md](./CONTRIBUTING.md) and join in. | ||
|
||
Since this is a Kibana plugin, it can be useful to review the [Kibana contributing guide](https://github.com/elastic/kibana/blob/master/CONTRIBUTING.md) alongside the documentation around [Kibana plugins](https://www.elastic.co/guide/en/kibana/master/kibana-plugins.html) and [plugin development](https://www.elastic.co/guide/en/kibana/current/plugin-development.html). | ||
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/opendistro-for-elasticsearch/kibana-visualizations/issues). | ||
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). | ||
|
||
## License | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder whether this should be
ganttchartDashboards
, but also maybe it doesn't matter, @saratvemulapalli ?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah I would prefer to have
ganttchartDashboards
.Looking other plugins, looks like few of them do follow camel case, and few don't. (I looked at AD, Alerting and security).
Understanding the reason behind it, because it is a file name folks prefer to start with lowercase.
No hard rules, but it would be nice to have it consistent.