Skip to content

docs: Move tutorial content from GitHub repo into the website#6746

Open
harshitghagre wants to merge 3 commits intopipe-cd:masterfrom
harshitghagre:docs/integrate-tutorial-into-website
Open

docs: Move tutorial content from GitHub repo into the website#6746
harshitghagre wants to merge 3 commits intopipe-cd:masterfrom
harshitghagre:docs/integrate-tutorial-into-website

Conversation

@harshitghagre
Copy link
Copy Markdown
Contributor

What this PR does:
Moves the tutorial from the GitHub repo into the docs site.

  • Updated the Tutorial navbar link to /docs-v1.0.x/tutorial/
  • Added all tutorial pages to the docs
  • Added tutorial images to the docs site

Tested locally with hugo server and everything works fine.

Why we need it:
Right now the Tutorial link opens GitHub. This keeps the tutorial inside the docs site and makes it easier to follow.

Which issue(s) this PR fixes:
Fixes #6745

Does this PR introduce a user-facing change?:

  • Users can now read the full tutorial directly on the docs site
  • Breaking change: No

Screenshot

image

@harshitghagre harshitghagre requested review from a team as code owners May 7, 2026 05:30
@harshitghagre harshitghagre force-pushed the docs/integrate-tutorial-into-website branch from 10460bc to 940ccd1 Compare May 7, 2026 05:31
Comment thread .github/workflows/first-time-contributor.yaml Outdated
@harshitghagre harshitghagre force-pushed the docs/integrate-tutorial-into-website branch from 02b5e35 to fec528f Compare May 7, 2026 10:51
Copy link
Copy Markdown
Contributor

@rahulshendre rahulshendre left a comment

Choose a reason for hiding this comment

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

Thanks @harshitghagre, this seems like a good idea.
However, there is one issue:

The tutorial content is for v0, not v1

  • install-piped.md downloads piped_v0.50.1 binary (hardcoded)
  • piped.yaml in pipe-cd/tutorial uses platformProviders, this is the v0 config schema. v1 uses a plugin-based architecture with a completely different config format and binary (pipedv1)
  • The pipe-cd/tutorial repo itself hasn't been updated since Feb 2025 (last commit bumped images to v0.50.1).

We don't have a v1 tutorial repo yet.

So, placing this under v1 is wrong, users will install a v0 binary with v0 config, and either get failures or unexpected behavior.

You can retarget this to docs-v0 instead : )
Feel free to ask any doubts you might have regarding this

@harshitghagre harshitghagre force-pushed the docs/integrate-tutorial-into-website branch from 18aeaa4 to 198b944 Compare May 8, 2026 04:50
The Tutorial navbar link redirected to an external GitHub repo (pipe-cd/tutorial). This moves the tutorial content directly into the docs site under /docs-v0.50.x/tutorial/ since the tutorial uses piped v0.50.1 and v0 config schema (platformProviders).

Changes:

- Update config.toml: point Tutorial nav link to /docs-v0.50.x/tutorial/

- Add 11 tutorial pages under docs/content/en/docs-v0.50.x/tutorial/

- Add tutorial images under docs/static/images/tutorial/

Signed-off-by: harshitghagre <harshitghagre183@gmail.com>
@Ayushmore1214
Copy link
Copy Markdown
Contributor

@harshitghagre One more thing, before making such big changes lets discuss things with all the members and contributors , you can tag me, @rahulshendre, @eeshaanSA or @khanhtc1202 to discuss things before going for a PR, without discussing it leads to something like this above (v0, v1 issue), so discuss things early tag people, tag again if they don't reply, people like rahul and eeshan are always open to guide through this, keep going!!! ❤️

@harshitghagre harshitghagre force-pushed the docs/integrate-tutorial-into-website branch from 198b944 to ec60cb2 Compare May 8, 2026 04:52
@harshitghagre
Copy link
Copy Markdown
Contributor Author

Thanks @harshitghagre, this seems like a good idea. However, there is one issue:

The tutorial content is for v0, not v1

  • install-piped.md downloads piped_v0.50.1 binary (hardcoded)
  • piped.yaml in pipe-cd/tutorial uses platformProviders, this is the v0 config schema. v1 uses a plugin-based architecture with a completely different config format and binary (pipedv1)
  • The pipe-cd/tutorial repo itself hasn't been updated since Feb 2025 (last commit bumped images to v0.50.1).

We don't have a v1 tutorial repo yet.

So, placing this under v1 is wrong, users will install a v0 binary with v0 config, and either get failures or unexpected behavior.

You can retarget this to docs-v0 instead : ) Feel free to ask any doubts you might have regarding this

thanks for review @rahulshendre , the website was showing v1 by default so I just went with that, didn't realize the tutorial content was still on v0 now i've updated please review.

@harshitghagre
Copy link
Copy Markdown
Contributor Author

@harshitghagre One more thing, before making such big changes lets discuss things with all the members and contributors , you can tag me, @rahulshendre, @eeshaanSA or @khanhtc1202 to discuss things before going for a PR, without discussing it leads to something like this above (v0, v1 issue), so discuss things early tag people, tag again if they don't reply, people like rahul and eeshan are always open to guide through this, keep going!!! ❤️

noted @Ayushmore1214 , I’ll make sure to do from next time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Move Tutorial content into website docs instead of redirecting to GitHub

3 participants