JanusGraph / JanusGraph/janusgraph

YAML code blocks not rendered in Changelog

Open
#2,844 0 comments 0 reactions 0 assignees View on GitHub
area/docs kind/bug/confirmed
Dominant language
Java
Stars
5.8k
Forks
1.2k
Avg merge
13h 53m
Merged PRs (30d)
6

Description

YAML code blocks seem to be missing in the Changelog.

The `changelog.md` contains this:

> If you want to use GraphBinary, you have to add following to the `gremlin-server.yaml`
> after the keyword `serializers`. This will add the support on the server site.
>
> ```yaml
> - { className: org.apache.tinkerpop.gremlin.driver.ser.GraphBinaryMessageSerializerV1,
> config: { ioRegistries: [org.janusgraph.graphdb.tinkerpop.JanusGraphIoRegistry] }}
> - { className: org.apache.tinkerpop.gremlin.driver.ser.GraphBinaryMessageSerializerV1,
> config: { serializeResultToString: true }}
>
> ```

But I don't see the YAML in the rendered page:
![image](https://user-images.githubusercontent.com/21224336/140072730-dd4dd28a-8b9b-443c-b335-d87cc1d64373.png)
https://docs.janusgraph.org/changelog/#graphbinary-is-now-supported

This however seems to be limited to the Changelog. YAML code blocks are rendered correctly in the rest of the docs, e.g., here: https://docs.janusgraph.org/configs/#janusgraph-server

Contributor guide

Open the contributing guide

Research direction

Start with changelog.md and compare its YAML fenced block with the correctly rendered example on the configs page. Inspect the documentation rendering path for the Changelog, then verify that the YAML block appears on the rendered changelog page without affecting other documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, yaml
Domain
documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.