docs: Move tutorial content from GitHub repo into the website#6746
docs: Move tutorial content from GitHub repo into the website#6746harshitghagre wants to merge 3 commits intopipe-cd:masterfrom
Conversation
10460bc to
940ccd1
Compare
02b5e35 to
fec528f
Compare
rahulshendre
left a comment
There was a problem hiding this comment.
Thanks @harshitghagre, this seems like a good idea.
However, there is one issue:
The tutorial content is for v0, not v1
install-piped.mddownloadspiped_v0.50.1binary (hardcoded)piped.yamlinpipe-cd/tutorialusesplatformProviders, this is the v0 config schema. v1 uses a plugin-based architecture with a completely different config format and binary (pipedv1)- The
pipe-cd/tutorialrepo 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
18aeaa4 to
198b944
Compare
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>
|
@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!!! ❤️ |
198b944 to
ec60cb2
Compare
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. |
noted @Ayushmore1214 , I’ll make sure to do from next time. |
What this PR does:
Moves the tutorial from the GitHub repo into the docs site.
/docs-v1.0.x/tutorial/Tested locally with
hugo serverand 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?:
Screenshot