Skip to content

Commit

Permalink
feat!: new docs structure (Nixtla#534)
Browse files Browse the repository at this point in the history
* feat!:docs structure

* feat: add contribute

* Synchronize CONTRIBUTING.md from nixtla-commons - Triggered by Github Workflows (Nixtla#535)

* [docs]: synchronize styles from nixtla-commons - Triggered by Github Workflows (Nixtla#536)

* fix: remove unwanted files

* [docs]: synchronize contribute from nixtla-commons - Triggered by Github Workflows (Nixtla#537)

* fix: remove unwanted exsample files

* feat: add notest file

* fix: add notest file

* fix: add missing notest files

* fix: improve ci tests

* fix: ray version
  • Loading branch information
AzulGarza authored Jun 13, 2023
1 parent a7f0957 commit c732a61
Show file tree
Hide file tree
Showing 79 changed files with 1,451 additions and 192,068 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ jobs:
if: ${{ matrix.os != 'windows-latest' }}
run: |
pip install ".[dev]" pytest
pytest action_files
pytest action_files
test-m3-performance:
runs-on: ubuntu-latest
Expand Down
3 changes: 2 additions & 1 deletion dev/environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,10 @@ dependencies:
- tabulate
- plotly
- pip:
- ray<2.5.0
- fugue[dask,ray]
- nbdev
- plotly-resampler
- polars
- supersmoother
- tqdm
- tqdm
Binary file added nbs/assets/Inter-VariableFont.ttf
Binary file not shown.
Binary file added nbs/assets/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes.
File renamed without changes.
55 changes: 55 additions & 0 deletions nbs/docs/contribute/contribute.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: Contribute to Nixtla
sidebarTitle: How to Contribute
---

Thank you for your interest in contributing to Nixtla. Nixtla is free, open-source software and welcomes all types of contributions, including documentation changes, bug reports, bug fixes, or new source code changes.


## Contribution issues 🔧

Most of the issues that are open for contributions will be tagged with
`good first issue` or `help wanted`. A great place to start looking will be our
GitHub projects for:

- Community writers [dashboard](https://github.com/orgs/Nixtla/projects/9).
- Community code contributors [dashboard](https://github.com/orgs/Nixtla/projects/6).

Also, we are always open to suggestions so feel free to open new issues with
your ideas and we can give you guidance!

After you find the issue that you want to contribute to, follow the
`fork-and-pull` workflow:

1. Fork the Nixtla repository you want to work on (e.g. StatsForecast or NeuralForecast)
2. Clone the repository locally (`git clone`) and create a new branch (`git checkout -b my-new-branch`)
3. Make changes and commit them
4. Push your local branch to your fork
5. Submit a Pull Request so that we can review your changes
6. Write a commit message
7. Make sure that the CI tests are GREEN (CI tests refer to automated tests that are run on code changes to ensure that new additions or modifications do not introduce new errors or break existing functionality.)

<Note>
Be sure to merge the latest from "upstream" before making a Pull Request!
</Note>

You can find a complete step-by-step guide on this `fork-and-pull` workflow [here](https://github.com/Nixtla/how-to-contribute-nixtlaverse).

Pull Request reviews are done on a regular basis. Please make sure you respond
to our feedback/questions and sign our CLA.

## Documentation 📖

We are committed to continuously improving our documentation. As such, we warmly welcome any Pull Requests that focus on improving our grammar, documentation structure, or fixing any typos.

- Check the `documentation` tagged issues and help us.

## Write for us 📝

Do you find Nixtla useful and want to share your story or create some content? Make a PR to this repo
with your writing in a markdown file, or just post it on Medium, Dev or your own
blog post. We would love to hear from you 💚

<Note>
This document is based on the documentation from [MindsDB](https://github.com/mindsdb/mindsdb)
</Note>
7 changes: 7 additions & 0 deletions nbs/docs/contribute/docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Nixtla Documentation
sidebarTitle: Writing Documentation
---

TBD

61 changes: 61 additions & 0 deletions nbs/docs/contribute/issue-labels.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
title: Understanding Issue Labels
sidebarTitle: Interpreting Issue Labels
---

This segment delves into the variety of issue labels used within the [Nixtla GitHub repository](https://github.com/nixtla/nixtla).

## Labels Relevant to Contributors

Should you be a contributor now or in the future, it's important to take note of issues flagged with these labels.

### The `first-timers-only` Label

For those who have not yet contributed to Nixtla, start by looking for issues tagged as `first-timers-only`.

Please note that before we can accept your contribution to Nixtla, you'll need to sign our [Contributor License Agreement](https://github.com/nixtla/nixtla_native/blob/stable/assets/contributions-agreement/individual-contributor.md).

You can browse all `first-timers-only` issues [here](https://github.com/nixtla/nixtla/labels/first-timers-only).

### The `good first issue` Label

Issues labeled as `good first issue` are ideal for newcomers.

You can browse all `good first issue` issues [here](https://github.com/nixtla/nixtla/labels/good%20first%20issue).

### The `help wanted` Label

Issues tagged as `help wanted` are open to anyone who wishes to contribute to Nixtla.

You can browse all `help wanted` issues [here](https://github.com/nixtla/nixtla/labels/help%20wanted).

### The `bug` Label

The `bug` label flags issues that outline something that's currently not functioning correctly.

You can report a bug by following the instructions [here](/contribute/issues#report-a-bug).

### The `discussion` Label

If an issue is labeled as `discussion`, it signifies that more conversation is needed before it can be resolved.

### The `documentation` Label

The `documentation` label identifies issues pertaining to our documentation.

You can contribute to improving our documentation by creating issues following the guidelines [here](/contribute/issues#improve-our-docs).

### The `enhancement` Label

As Nixtla continues to evolve, there are always areas that can be enhanced. All issues suggesting improvements to Nixtla are tagged with the `enhancement` label.

You can propose a feature by following the instructions [here](/contribute/issues#request-a-feature).

### The `discussion` Label

If an issue is labeled as `discussion`, it needs more information before it can be resolved.

### The `requested` Label

Our users are welcomed to propose improvements, report bugs, request feature, etc. Any issue originating from them is flagged as `requested`.

97 changes: 97 additions & 0 deletions nbs/docs/contribute/issues.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
---
title: Submit an Issue 📢
sidebarTitle: Submit an Issue
---

To report a bug, request a feature, propose a new integration, or suggest documentation improvements, please visit the [Nixtla GitHub issues page](https://github.com/nixtla/nixtla/issues). Before submitting a new issue, kindly check if it has already been reported.

## Steps to Submit an Issue

Here's a step-by-step guide on submitting an issue to the Nixtla repository.

Visit [our GitHub issues page](https://github.com/nixtla/nixtla/issues) and click on the _New issue_ button.

A list of available issue types will be displayed.

### Reporting a Bug 🐞

Select `Report a bug` and click on the _Get started_ button.

The form to report the bug will appear.

1. Begin by adding a concise, informative title.
2. Describe the bug you've observed. This information is required. You can also attach relevant videos or screenshots.
3. If you're aware of what the correct behavior should be, note it down here.
4. Documenting the steps leading to the bug will be of immense help to us.
5. You can also add links, references, logs, screenshots, and so on.

<Info>
Please ensure that your contributions abide by the [contributing guidelines](https://github.com/nixtla/nixtla/blob/staging/CONTRIBUTING.md) and [code of conduct](https://github.com/nixtla/nixtla/blob/staging/CODE_OF_CONDUCT.md).
</Info>

Thank you for your contribution! Your report aids in refining Nixtla for current and future users.

### Feature Request 🚀

Select `Request a feature` and click the _Get started_ button.

The feature request form will appear.

1. Start with a significant, clear title.
2. Provide a detailed description of the feature you want to request, along with the reasoning behind the request. This field is mandatory. Feel free to attach related videos or screenshots.
3. If you have an idea of how the feature should work, include it.
4. Additional references, links, logs, and screenshots are welcome!

<Info>
Please ensure that your contributions abide by the [contributing guidelines](https://github.com/nixtla/nixtla/blob/staging/CONTRIBUTING.md) and [code of conduct](https://github.com/nixtla/nixtla/blob/staging/CODE_OF_CONDUCT.md).
</Info>

Thank you for your feature request! It will help us enhance Nixtla for all users.

### Suggest Documentation Improvements ✍️

Select `Improve our docs` and click the _Get started_ button.

A form for suggesting improvements will appear.

1. A clear, concise title is important.
2. Describe the improvements you believe are needed. This field is mandatory. Attach any related videos or screenshots, if necessary.
3. Any additional references, links, logs, screenshots are appreciated!

<Info>
Please ensure that your contributions abide by the [contributing guidelines](https://github.com/nixtla/nixtla/blob/staging/CONTRIBUTING.md) and [code of conduct](https://github.com/nixtla/nixtla/blob/staging/CODE_OF_CONDUCT.md).
</Info>

Thank you for your valuable suggestions! Your input helps us refine Nixtla's documentation.

### Proposing a New Integration 🧑‍🔧

If you have a proposal for a new database integration or a new machine learning framework, here's how to get started:

Select `

Propose a new integration` and click the _Get started_ button.

A form for your proposal will appear.

1. Start with a clear, concise title.
2. Describe your proposal and why it is needed. This field is mandatory. Feel free to attach any related videos or screenshots.
3. If you have an idea of how this integration should work, include it.
4. Any additional references, links, logs, screenshots, and so on, are welcome!

<Info>
Please ensure that your contributions abide by the [contributing guidelines](https://github.com/nixtla/nixtla/blob/staging/CONTRIBUTING.md) and [code of conduct](https://github.com/nixtla/nixtla/blob/staging/CODE_OF_CONDUCT.md).
</Info>

Thank you for your proposal! Your suggestion helps us extend the capabilities of Nixtla.

## Reviewing Issues

- Issues are reviewed on a regular basis, usually every day.
- Issues will be labeled as `Bug` or `enhancement` based on their type.
- Please be ready to respond to our feedback or questions regarding your issue.

<Note>
This document is based on the documentation from [MindsDB](https://github.com/mindsdb/mindsdb)
</Note>

Loading

0 comments on commit c732a61

Please sign in to comment.