search

jenkins-infra / stats.jenkins.io

Revamped Jenkins Infra Stats Website as a part of GSoC 2024
https://new.stats.jenkins.io
3 stars 4 forks source link

Add instructions how to build the website in the README #2

Closed lemeurherve closed 1 week ago

lemeurherve commented 2 weeks ago

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

There is no instruction how to locally build the website in the README.

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

No response

shlomomdahan commented 1 week ago

@lemeurherve I added some helpful instructions of the readme to get started with local development.

ref: https://github.com/jenkins-infra/stats.jenkins.io/pull/8

lemeurherve commented 1 week ago

Thanks!

Closed by https://github.com/jenkins-infra/stats.jenkins.io/pull/8

HagegeR commented 1 week ago

It is maybe just my opinion, but I believe the read-me should start by the purpose of the repo before getting into how to install/contribute etc.

krisstern commented 1 week ago

Hi @HagegeR, this project is a part of the ongoing GSoC 2024 and is not in production yet. There will be many additions to its documentation as the project progress. Currently it is still in its development phase.

HagegeR commented 1 week ago

I understand that @krisstern, but it might be something to revisit before finalizing the project

lemeurherve commented 1 week ago

For the record: https://github.com/jenkins-infra/helpdesk/issues/4132#issuecomment-2182602543

lemeurherve commented 1 week ago

Also: https://github.com/jenkinsci/plugin-modernizer-tool/pull/38