OpenLiberty / OpenLiberty/docs

Review/revise X-forwarded reference topic

Open
#217 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

maintenance
Dominant language
No language data
Stars
14
Forks
58
Avg merge
4m
Merged PRs (30d)
35

Description

https://draft-openlibertyio.mybluemix.net/docs/ref/general/#forwarded-header.html

This topic was copied mostly from the old-style doc issue that the developer created. Post-publishing, some urgent fixes have been made but it needs a full review and some revision, inc:

  • Move config snippets to generated doc when capability in #206 has been completed.
  • Identify and write concept topic.
  • Identify and create (if necessary after all generated doc has been checked and enhanced/updated if necessary) reference topic (ie if all the reference info in this topic actually is or could be in the generated docs that relate to this area, we don't need a manually created reference topic any more).
  • Remove references to the WebSphere Liberty Knowledge Center. Identify topics that need to be written for OL docs if those links are important and create issues to be prioritised.

Source of info
https://openliberty.io/blog/2018/12/20/http-forwarded-header.html

When complete, redirect the blog post to the concept topic (ask Alasdair how to do the redirect).

Contributor guide

Open the contributing guide

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

Start by reviewing the published X-forwarded reference topic at the linked URL and the Open Liberty blog post, then check the status of capability issue #206. Done means revising or replacing the concept and reference coverage, removing Knowledge Center links, creating follow-up issues where needed, and redirecting the blog post to the concept topic.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.