Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Node tutorial revamp #7095

Merged
merged 21 commits into from Feb 27, 2024
Merged

Conversation

gounthar
Copy link
Contributor

@gounthar gounthar commented Feb 19, 2024

This is a follow-up to the "Docker-based Jenkins quickstart examples" 2023 GSoC project.

The goal is to simplify the existing tutorial related to using Docker and eliminate BlueOcean, which is now deprecated.

To achieve this goal, we have a set of Docker images deployed in GHCR, and a repository hosting a docker-compose.yml file.

In this PR, I removed the existing screenshots illustrating BlueOcean and replaced them with screenshots from the Pipeline Graph View plugin.

You can preview the changes at https://deploy-preview-7095--jenkins-io-site-pr.netlify.app/doc/tutorials/build-a-node-js-and-react-app-with-npm/

@probot-autolabeler probot-autolabeler bot added the documentation Jenkins documentation, including user and developer docs, solution pages, etc. label Feb 19, 2024
@gounthar gounthar changed the title [Drafft] Node tutorial revamp [Draft] Node tutorial revamp Feb 19, 2024
@kmartens27
Copy link
Contributor

@gounthar from what I've found, it looks like the tutorials page does not have this copy to clipboard functionality overall. I've checked out the other tutorials (Getting Started Tour, current Node, Updated Python & Maven) and none of the tutorials have a copy function within their code blocks. This may have been missed initially when being worked on, but it doesn't seem to have been part of the conversation/work. There could be an argument that for the tutorials, users should be able to follow the instructions and fill in the information manually, but that goes against ease of use.

I'm not sure what would prevent the function from being included in those pages/sections, but it does not appear to be available at this time. As noted in the linked PR, Antora does offer this functionality out of the box, so it can be easily addressed when that move occurs.

@gounthar gounthar changed the title [Draft] Node tutorial revamp Node tutorial revamp Feb 20, 2024
@gounthar gounthar marked this pull request as ready for review February 20, 2024 21:25
@gounthar gounthar requested a review from a team as a code owner February 20, 2024 21:25
Copy link
Member

@NotMyFault NotMyFault left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

Copy link
Contributor

@kmartens27 kmartens27 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks very much @gounthar, everything looks great! I provided some feedback/suggestions but it is more grammatical and structural. The content looks good from here!

gounthar and others added 2 commits February 27, 2024 18:25
Thanks a lot for the detailed review, @kmartens27.

Co-authored-by: Kevin Martens <99040580+kmartens27@users.noreply.github.com>
@kmartens27 kmartens27 merged commit f1eb039 into jenkins-infra:master Feb 27, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Jenkins documentation, including user and developer docs, solution pages, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants