apache / apache/apisix-website

[Docs]: supports online preview of other APISIX repository documents.

Open
#1,076 2 comments 0 reactions 0 assignees View on GitHub
Enhancement
Dominant language
JavaScript
Stars
146
Forks
204
Avg merge
2d 3h
Merged PRs (30d)
21

Description

### Current State

**Description of the current state/issue**:

Among all Apache APISIX projects, only `apisix-website` documents and blogs support online preview, and other repositories do not support online preview. This increases the difficulty of review. If we can support online preview in each repository, it will greatly reduce the low error of the document.
It is hoped that the documentation of other APISIX repo will also support online preview.
https://github.com/apache/apisix-website/issues/582
https://github.com/apache/apisix/pull/6957#issuecomment-1111871543

### Desired State

**Description of the change you are proposing**:

### Would you like to fix this issue?

_No response_

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading the linked apisix-website issue #582 and the discussion on apache/apisix pull request #6957 to understand the existing online-preview approach and the other repositories involved. Done means establishing online preview for documentation in the other APISIX repositories, with the required scope and verification agreed in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.