Kong / Kong/developer.konghq.com

Entity Schemas are no longer rendered on the website anywhere

Open
#5,814 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

user-reported
Dominant language
Ruby
Stars
28
Forks
121
Avg merge
1d 4h
Merged PRs (30d)
313

Description

Jobs to be done (optional)

Fix website generation so that schema docs are properly rendered in the UI again

Definition of done

Schemas are rendered as part of the website UI again

Information

Go to any page under the following: https://developer.konghq.com/gateway/entities/

you will notice that the schema section is blank on (as far as I can tell) each entity definition. Here is a direct link for plugins https://developer.konghq.com/gateway/entities/plugin/#schema

note that the section rendered appears to be blank

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the blank schema section on the entity pages, especially https://developer.konghq.com/gateway/entities/plugin/#schema. Trace the website-generation path that supplies schema content to the entity UI. Done means schema sections render with their expected content across the entity pages.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
documentation, web-dev
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.