Skip to content

ci(issue-template): create Website issue template - #1108

Open
AnkitRewar11 wants to merge 2 commits into
meshery:masterfrom
AnkitRewar11:website-template
Open

ci(issue-template): create Website issue template#1108
AnkitRewar11 wants to merge 2 commits into
meshery:masterfrom
AnkitRewar11:website-template

Conversation

@AnkitRewar11

@AnkitRewar11 AnkitRewar11 commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Notes for Reviewers

This PR fixes #1098

This PR creates a dedicated "Website" GitHub issue template (.github/ISSUE_TEMPLATE/website.md) for schemas.meshery.io, following the repository's casing rules and issue template conventions.

Changes Included

Signed commits

  • Yes, I signed my commits.

Summary by CodeRabbit

  • Documentation
    • Added a dedicated issue template for reporting website-related problems.
    • The template guides reporters to describe current and desired behavior and include optional screenshots or logs.
    • Added links to relevant contributor resources.

@welcome

welcome Bot commented Jul 29, 2026

Copy link
Copy Markdown

Yay, your first pull request! 👍 A contributor will be by to give feedback soon. In the meantime, you can find updates in the #github-notifications channel in the community Slack.
Be sure to double-check that you have signed your commits. Here are instructions for making signing an implicit activity while performing a commit.

@coderabbitai

coderabbitai Bot commented Jul 29, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: cd5590ca-1bc9-4a40-b45b-c177954fa631

📥 Commits

Reviewing files that changed from the base of the PR and between c8c440d and 839e643.

📒 Files selected for processing (1)
  • .github/ISSUE_TEMPLATE/website.md

📝 Walkthrough

Walkthrough

Adds a GitHub issue template for website-related reports. The template includes metadata, behavior prompts, optional screenshots or logs, and contributor resource links.

Changes

Website issue reporting

Layer / File(s) Summary
Website issue intake template
.github/ISSUE_TEMPLATE/website.md
Adds GitHub issue metadata, prompts for current and desired behavior, optional screenshots or logs, and contributor resource links.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the creation of a Website issue template, which is the main change.
Linked Issues check ✅ Passed The PR adds the dedicated Website issue template, website-specific sections, and contributor resources required by issue #1098.
Out of Scope Changes check ✅ Passed The changes are limited to the requested Website issue template and its supporting content.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/ISSUE_TEMPLATE/website.md:
- Line 9: Update the top-level section headings in the website issue template,
including “Current Behavior” and the peer sections at the referenced locations,
from level-3 headings to level-2 headings so the template hierarchy is
consistent and satisfies MD001.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 5245efa7-8f52-4cb7-a21c-b89377fc720b

📥 Commits

Reviewing files that changed from the base of the PR and between 04571f6 and c8c440d.

📒 Files selected for processing (1)
  • .github/ISSUE_TEMPLATE/website.md

Comment thread .github/ISSUE_TEMPLATE/website.md
@github-actions github-actions Bot added the area/ci Continuous integration | Build and release label Jul 29, 2026

@Maanvi212006 Maanvi212006 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Went through this end to end (diff, content, labels config, and checked live labels on GitHub) — LGTM overall.

One thing to fix before merge: the template uses area/website as a label, but that label doesn't actually exist in the repo yet. Right now it'll just silently not get applied when someone files an issue. Could we create it first, or use an existing label instead?

@AnkitRewar11

Copy link
Copy Markdown
Contributor Author

@Maanvi212006 Thanks for catching that! If we have to use a pre-existing label here, I think area/docs is the best option as it already serves schemas.meshery.io. Do you think that makes sense, or would you prefer introducing a dedicated area/website label instead?

@Maanvi212006

Copy link
Copy Markdown

@AnkitRewar11 maybe we can introduce a new label dedicated to website.
@rishiraj38 @ishwar170695 suggestions?

@ishwar170695

ishwar170695 commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

@Maanvi212006 I lean towards using area/docs for now.
Looking through the repository, I don't see evidence that the website is treated as a separate area, and we already have framework/jekyll to distinguish website-related issues. Unless there's a broader plan to split website work into its own category, reusing area/docs seems sufficient.

@AnkitRewar11

Copy link
Copy Markdown
Contributor Author

Sounds good! I'll update the label to area/docs and push the changes. Since it's already being used for both documentation and website-related content, I think it's the most appropriate choice for now.
@Maanvi212006 @ishwar170695

Signed-off-by: Ankit Rewar <AnkitRewar11@users.noreply.github.com>
@AnkitRewar11

Copy link
Copy Markdown
Contributor Author

@ishwar170695 Hello, good morning! Please, whenever you have time, take a look at this. Have a nice day! 🙌

@Maanvi212006 Maanvi212006 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

name: 🌐 Website issue
about: Issues related to website.
title: '[Website]'
labels: 'area/docs, framework/jekyll'

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs?

Perhaps, a new dedicated label is needed.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sir, I had initially suggested using area/website, as you can see in the earlier conversation above. However, I later changed it to area/docs. Although area/website was a new label, after our discussion I felt that area/docs was the most appropriate choice, so I updated it accordingly.

@emphor11

emphor11 commented Aug 9, 2026

Copy link
Copy Markdown

LGTM!

@banana-three-join
banana-three-join self-requested a review August 9, 2026 16:45
@AnkitRewar11

Copy link
Copy Markdown
Contributor Author

Hey, could you please have a look when you get some time and let me know if there are any other changes needed? Otherwise, I think everything looks good. @banana-three-join

@banana-three-join banana-three-join left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't agree with the area/docs label. There's currently a docs folder and a documentation.md template which already uses the 'area/docs, framework/jekyll, language/markdown' labels so there needs to be a bigger differentiator between the two of them to have a better track of the issues.

You can use something like area/site since that's the folder where the main logic for https://schemas.meshery.io/ resides.

@AnkitRewar11

Copy link
Copy Markdown
Contributor Author

I also agree with your point about using the Area/Site label. However, @ishwar170695 and @Maanvi212006 suggested that since this is a new label, using Area/Docs would be more appropriate. That said, we can go with Area/Site if you think that’s better. I’ll push a new commit with the Area/Site label. @banana-three-join

@banana-three-join

Copy link
Copy Markdown
Contributor

I did see both of their points and while I do think they're right, I also think that applying a placeholder label in the meanwhile because there isn't another label available, isn't the preferred approach. Let me go take a look at to how the other repos do it so I can comeback with a more conclusive answer.

Thanks to both of you for helping out over in this area! @Maanvi212006 @AnkitRewar11

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/ci Continuous integration | Build and release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[CI] Create a "Website" GitHub issue template

6 participants