search

jenkins-infra / docs.jenkins.io

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

Update the documentation at site/ for the Gatsby-based jenkins.io website #123

Open krisstern opened 2 days ago

krisstern commented 2 days ago

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

We currently have a stub as a documentation at https://github.com/jenkins-infra/docs.jenkins.io/blob/main/site/README.md which we will need to either update/add details, which should include (but not necessarily limited to) the following:

  1. Change the startup command at #running-the-project to :

    npm run clean && npm run develop

  2. Add details about which folders are supposed to be generated by running the above command afresh and should be ignored with a ".gitignore" file.

  3. Link up this doc with the README.adoc at root

  4. Add any other details that may be relevant for the Gatsby site. (Open to suggestions!)

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

No response

Nwaamaka-Iduwe commented 1 day ago

Hi, I'd like to work on this.

Ashish-CodeJourney commented 20 hours ago

can you assign it to me ?

krisstern commented 20 hours ago

Hi @Nwaamaka-Iduwe Yes, you may work on this and post your progress here. If we do not here from you either here in this thread or receive a PR from you after 7 days, the issue will be released to someone else interested in this issue.

krisstern commented 20 hours ago

@Ashish-CodeJourney No, someone else asked before you did.

Nwaamaka-Iduwe commented 19 hours ago

Hi @Nwaamaka-Iduwe Yes, you may work on this and post your progress here. If we do not here from you either here in this thread or receive a PR from you after 7 days, the issue will be released to someone else interested in this issue.

Thanks, noted.