#6 The redhat-sectech.gitlab.io site does not seem to exist.
Merged 4 years ago by mjahoda. Opened 4 years ago by adelton.
adelton/defensive-coding-guide presentation-url  into  master

file modified
+1 -1
@@ -5,7 +5,7 @@ 

  The guide is present in HTML form (auto-generated from this

  repository) at:

  

-  * http://redhat-sectech.gitlab.io/defensive-coding-guide

+  * https://redhat-crypto.gitlab.io/defensive-coding-guide

  

  

  # Building HTML documentation

no initial comment

I don't think https://developers.redhat.com/articles/defensive-coding-guide/ is generated from this source. The "The Defensive Coding Guide provides guidelines" text is nowhere in the source, instead the source says "This document provides guidelines" which is what seems to be at http://redhat-crypto.gitlab.io/defensive-coding-guide/.

The https://developers.redhat.com/articles/defensive-coding-guide/ looks like a static page that was crafted manually, linking to http://redhat-crypto.gitlab.io/defensive-coding-guide/.

The history is that http://redhat-crypto.gitlab.io/defensive-coding-guide/ was generated from https://gitlab.com/redhat-crypto/defensive-coding-guide . When it moved here the plan was to auto-generate a site similar to the original, but I have no idea what is it now.

Who might know the current setup?

The current setup is the following:

Two years ago, when we had been working on it, Asciibinder was not able process xrefs. Then Fedora Docs switched to Antora and I was under impression that this Asciidoc book still requires some changes to be compatible with the current docs.fp.o toolchain.

@pbokoc Could you please tell us what steps are necessary to have Defensive Coding Guide attached to (and built by) the current CI on Fedora Docs?

Alternatively, @tcapek, given that the teaser article is on https://developers.redhat.com/, would it make sense to build it somewhere into the .redhat.com space?

@adelton we had many discussions on that topic, and the consensus was to not have the Defensive Coding Guide in the Customer Portal docs for the following reasons:

  • we do not have maintainers (owners) for many sections -> we cannot ensure the quality
  • the content is not RHEL-specific

I am merging this straightforward PR and I have filed https://pagure.io/defensive-coding-guide/issue/7

Pull-Request has been merged by mjahoda

4 years ago
Metadata