Skip to content

Commit b098798

Browse files
htahir1actions-userstrickvl
authored
Update issue template configurations and URLs (#3756)
* Update issue template configurations and URLs * Auto-update of LLM Finetuning template * Update .github/ISSUE_TEMPLATE/feature_report.yml Co-authored-by: Alex Strick van Linschoten <[email protected]> * Update .github/ISSUE_TEMPLATE/feature_report.yml Co-authored-by: Alex Strick van Linschoten <[email protected]> --------- Co-authored-by: GitHub Actions <[email protected]> Co-authored-by: Alex Strick van Linschoten <[email protected]>
1 parent e941c5e commit b098798

File tree

6 files changed

+89
-13
lines changed

6 files changed

+89
-13
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ body:
2525
< 0.36.0, then remove the `-s` flag above. If using ZenML version < 0.8.0,
2626
then paste in Python version, OS, ZenML version, and installed integrations.
2727
validations:
28-
required: true
28+
required: false
2929
- type: textarea
3030
id: what-happened
3131
attributes:

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ contact_links:
55
url: https://zenml.io/discussion
66
about: Request a new feature.
77
- name: Slack Channel
8-
url: https://zenml.io/slack-invite/
8+
url: https://zenml.io/slack/
99
about: Chat with us directly here.
1010
- name: Docs
1111
url: https://docs.zenml.io/
Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
name: Feature Request
3+
description: Suggest a new feature or enhancement
4+
title: '[FEATURE]: '
5+
labels: [enhancement, feature-request]
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to suggest a new feature! Your ideas help make ZenML better.
11+
- type: input
12+
id: contact
13+
attributes:
14+
label: Contact Details [Optional]
15+
description: How can we get in touch with you if we need more info?
16+
placeholder: [email protected]
17+
validations:
18+
required: false
19+
- type: textarea
20+
id: feature-description
21+
attributes:
22+
label: Feature Description
23+
description: What feature would you like to see added to ZenML?
24+
placeholder: A clear and concise description of the feature you'd like to see
25+
implemented.
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: problem-statement
30+
attributes:
31+
label: Problem or Use Case
32+
description: What problem does this feature solve? What use case does it enable?
33+
placeholder: Describe the problem you're trying to solve or the workflow you're
34+
trying to enable.
35+
validations:
36+
required: false
37+
- type: textarea
38+
id: proposed-solution
39+
attributes:
40+
label: Proposed Solution
41+
description: How do you envision this feature working?
42+
placeholder: Describe your ideal solution and how users would interact with
43+
it.
44+
validations:
45+
required: false
46+
- type: textarea
47+
id: alternatives
48+
attributes:
49+
label: Alternatives Considered
50+
description: Have you considered any alternative solutions or workarounds?
51+
placeholder: Describe any alternative solutions or features you've considered.
52+
validations:
53+
required: false
54+
- type: textarea
55+
id: additional-context
56+
attributes:
57+
label: Additional Context
58+
description: Add any other context, mockups, examples, or implementation ideas.
59+
placeholder: Screenshots, code examples, links to similar features, etc.
60+
validations:
61+
required: false
62+
- type: dropdown
63+
id: priority
64+
attributes:
65+
label: Priority
66+
description: How important is this feature to you?
67+
options:
68+
- Low - Nice to have
69+
- Medium - Would improve my workflow
70+
- High - Critical for my use case
71+
validations:
72+
required: false
73+
- type: checkboxes
74+
id: terms
75+
attributes:
76+
label: Code of Conduct
77+
description: By submitting this issue, you agree to follow our [Code of Conduct](CODE-OF-CONDUCT.md)
78+
options:
79+
- label: I agree to follow this project's Code of Conduct
80+
required: true

README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -312,17 +312,13 @@ ZenML is being built in public. The [roadmap](https://zenml.io/roadmap) is a reg
312312
ZenML is managed by a [core team](https://zenml.io/company) of developers that are responsible for making key decisions and incorporating feedback from the community. The team oversees feedback via various channels,
313313
and you can directly influence the roadmap as follows:
314314

315-
- Vote on your most wanted feature on our [Discussion
316-
board](https://zenml.io/discussion).
315+
- Ask questions and share your thoughts on the [Discussions board](https://zenml.io/discussion).
317316
- Start a thread in our [Slack channel](https://zenml.io/slack).
318317
- [Create an issue](https://github.com/zenml-io/zenml/issues/new/choose) on our GitHub repo.
319318

320319
## 🙌 Contributing and Community
321320

322-
We would love to develop ZenML together with our community! The best way to get
323-
started is to select any issue from the `[good-first-issue`
324-
label](https://github.com/issues?q=is%3Aopen+is%3Aissue+archived%3Afalse+user%3Azenml-io+label%3A%22good+first+issue%22)
325-
and open up a Pull Request!
321+
We would love to develop ZenML together with our community! The best way to get started is to select any issue from the [`good-first-issue` label](https://github.com/issues?q=is%3Aopen+is%3Aissue+archived%3Afalse+user%3Azenml-io+label%3A%22good+first+issue%22) and open up a Pull Request!
326322

327323
If you
328324
would like to contribute, please review our [Contributing
@@ -331,7 +327,7 @@ Guide](CONTRIBUTING.md) for all relevant details.
331327
## 🆘 Getting Help
332328

333329
The first point of call should
334-
be [our Slack group](https://zenml.io/slack-invite/).
330+
be [our Slack group](https://zenml.io/slack/).
335331
Ask your questions about bugs or specific use cases, and someone from
336332
the [core team](https://zenml.io/company) will respond.
337333
Or, if you

RELEASE_NOTES.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6291,7 +6291,7 @@ creating pipelines. It also improves the Airflow orchestrator logic to accommoda
62916291
* Numerous bugs and performance improvements. #136, @bcdurak great job with #142
62926292
* Added new docs with a low level API guide. #143
62936293
6294-
[Our roadmap](https://zenml.hellonext.co/roadmap) goes into further detail on the timeline. Vote on the [next features now](https://github.com/zenml-io/zenml/discussions).
6294+
[Our roadmap](https://zenml.io/roadmap) goes into further detail on the timeline.
62956295
62966296
We encourage every user (old or new) to start afresh with this release. Please go over our latest [docs](https://docs.zenml.io) and [examples](examples) to get a hang of the new system.
62976297
@@ -6339,7 +6339,7 @@ be included in the non-RC version of this release.
63396339
* Support for `KubernetesOrchestrator`, `KubeflowOrchestrator`, `GCPOrchestrator` and `AWSOrchestrator` are also planned.
63406340
* Dependency management including Docker support is planned.
63416341
6342-
[Our roadmap](https://zenml.hellonext.co/roadmap) goes into further detail on the timeline.
6342+
[Our roadmap](https://zenml.io./roadmap) goes into further detail on the timeline.
63436343
63446344
We encourage every user (old or new) to start afresh with this release. Please go over our latest [docs](https://docs.zenml.io)
63456345
and [examples](examples) to get a hang of the new system.
@@ -6388,7 +6388,7 @@ be included in the non-RC version of this release.
63886388
* Support for `KubernetesOrchestrator`, `KubeflowOrchestrator`, `GCPOrchestrator` and `AWSOrchestrator` are also planned.
63896389
* Dependency management including Docker support is planned.
63906390
6391-
[Our roadmap](https://zenml.hellonext.co/roadmap) goes into further detail on the timeline.
6391+
[Our roadmap](https://zenml.io/roadmap) goes into further detail on the timeline.
63926392
63936393
We encourage every user (old or new) to start afresh with this release. Please go over our latest [docs](https://docs.zenml.io)
63946394
and [examples](examples) to get a hang of the new system.

docs/book/reference/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Not really! An orchestrator in MLOps is the system component that is responsible
2121

2222
Take a look at our [documentation](https://docs.zenml.io) (in particular the [component guide](https://docs.zenml.io/stacks)), which contains instructions and sample code to support each integration that ZenML supports out of the box. You can also check out [our integration test code](https://github.com/zenml-io/zenml/tree/main/tests/integration/examples) to see active examples of many of our integrations in action.
2323

24-
The ZenML team and community are constantly working to include more tools and integrations to the above list (check out the [roadmap](https://zenml.io/roadmap) for more details). You can [upvote features](https://zenml.io/discussion) you'd like and add your ideas to the roadmap.
24+
The ZenML team and community are constantly working to include more tools and integrations to the above list (check out the [roadmap](https://zenml.io/roadmap) for more details).
2525

2626
Most importantly, ZenML is extensible, and we encourage you to use it with whatever other tools you require as part of your ML process and system(s). Check out [our documentation on how to get started](../introduction.md) with extending ZenML to learn more!
2727

0 commit comments

Comments
 (0)