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.

Sign up for GitHub

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

Jump to bottom

Enable Documentation preview on each PR #20

Open
cshilwant opened this issue Oct 28, 2024 · 4 comments
Open

Enable Documentation preview on each PR #20

cshilwant opened this issue Oct 28, 2024 · 4 comments

Comments

@cshilwant
Copy link
Member

For each PR, generate equivalent html output and host it somewhere.
This will help in reviewing docs and catching issues
@StaticRocket StaticRocket mentioned this issue Nov 10, 2024
Merged
@StaticRocket StaticRocket mentioned this issue Nov 30, 2024
Merged
@cshilwant
Copy link
Member Author

@StaticRocket @praneethbajjuri Moving the discussion here,

What's your thoughts on #126 (comment)

@StaticRocket
Copy link
Member

I'm not sure we should trust user provided previews, but I don't know.

Also, they'll have to tweak their workflows for that to pickup other branches. It just gets messy.

@praneethbajjuri
Copy link
Collaborator

Agreed here . Having PR level preview in the main doc project workflow makes sense.

@cshilwant
Copy link
Member Author

I see, Fair point!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@praneethbajjuri @StaticRocket @cshilwant