search

jenkins-infra / docs.jenkins.io

Versioned docs of jenkins.io
3 stars 15 forks source link

Update the documentation at "README.adoc" #121

Open krisstern opened 2 days ago

krisstern commented 2 days ago

Describe your use-case which is not covered by existing documentation.

The current documentation we have at https://github.com/jenkins-infra/docs.jenkins.io/blob/main/README.adoc is simply a stub, and needs reworking to provide more info such as the separation of the versioned controlled Antora part and the non-versioned controlled Gatsby part, where the latter is a basis of the to-be-replaced https://jenkins.io/ website.

Also, we could add some link to the existing Gatsby "README.md" at https://github.com/jenkins-infra/docs.jenkins.io/tree/main/site#readme.

Reference any relevant documentation, other materials or issues/pull requests that can be used for inspiration.

No response

Brijeshthummar02 commented 2 days ago

hey there, @krisstern i can work on this, assign me.

krisstern commented 2 days ago

Hi @Brijeshthummar02, Thanks for your interest in contributing! We do not normally assign issues, but you may work on this. Please keep us posted of any progress here in this thread. If we do not hear from you after 7 days, we will release the issue to be worked on by someone else interested.

Brijeshthummar02 commented 2 days ago

@krisstern pr is on, go through it.