envoyproxy/envoy

Bazel tag to indicate in the docs that the feature is not supported on all platforms

Open

#15,367 opened on Mar 8, 2021

View on GitHub
 (3 comments) (0 reactions) (0 assignees)C++ (5,373 forks)batch import
area/docsarea/windowshelp wanted

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (Avg merge 8d) (378 merged PRs in 30d)

Description

Description:

Add a bazel tag on extensions that are not supported on Windows (due to platform limitations) and then generate a note tag on the docs indicating that the feature is not supported.

Relevant Links:

Any extra documentation required to understand the issue.

See discussing at https://github.com/envoyproxy/envoy/pull/15298#pullrequestreview-606584419

Contributor guide

Research direction
Review the discussion in the linked PR #15298 to understand the proposed approach. Then explore existing Bazel tags in the repository for similar platform specific annotations. Finally, modify the Bazel build files and documentation generation code to implement the tag and note generation.
Tech stack
cpp
Domain
backendnetworking
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
BazelGitC++
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65