1/17/23 - ritz303 : Added a know issues text file

[ritz303]

Description

In reviewing the API documentation I found a few broken internal (xref) links. Currently, I don't have the time to track down the problem in the AsciiDoc generation code, and I don't want to forget about fixing them. I've added a temporary known-doc-issues.txt file, so I don't forget to fix the AsciiDoc generation code when I have time.

Type of change

• Added a temporary known doc issues text file.

Checklist (Definition of Done)

• All acceptance criteria specified in JIRA or in issue number have been completed
• Unit tests added that prove the fix is effective or the feature works
• Documentation added for the feature
• all relevant tests are passing
• Code Review completed
• Verified independently by reviewer

[redhatHameed]

@ritz303 how about creating GitHub issue instead of PR WDYT ?

[ritz303]

@redhatHameed : Yeah, I thought about creating an GitHub issue after I created this PR. Normally, I would just comment out the broken links in the "adoc" file and move on, but since the ref.adoc is dynamically generated I will lose my comments, so I added this known-doc-issues.txt file. Anyway, I went ahead and created issue #314 for these broken links. I'll leave it up to your discretion, if you want to close this PR or merge.

[redhatHameed]

@redhatHameed : Yeah, I thought about creating an GitHub issue after I created this PR. Normally, I would just comment out the broken links in the "adoc" file and move on, but since the ref.adoc is dynamically generated I will lose my comments, so I added this known-doc-issues.txt file. Anyway, I went ahead and created issue #314 for these broken links. I'll leave it up to your discretion, if you want to close this PR or merge.

@ritz303 thanks, if the current PR not fixing anything related to issue #314 then we can close this, if you want work further on this PR we can keep it open.