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

User guide, deployment page: add section 'Deployment on GitHub Pages' #1435

Merged
merged 4 commits into from
May 31, 2024

Conversation

deining
Copy link
Collaborator

@deining deining commented Feb 23, 2023

This PR adds a new section Deployment on GitHub Pages to the deployment page of the user guide.

You may have a look at the section preview at Netlify here.

The newly added section also refers to the deployment workfile, to be added to the example site via this PR. Both PRs are closely related and should be reviewed in parallel.

Thir PR also brings some minor corrections and amendments to the section Deployment with Netlify.

@deining deining added the user guide Improvements to user guide label Feb 23, 2023
@deining deining requested a review from LisaFC February 23, 2023 11:37
@LisaFC
Copy link
Collaborator

LisaFC commented Mar 6, 2023

Looks good! I made some small changes to the docs. @geriom or @chalin do you want to take a look? @Logofile I know you're using something GitHub Pages-y for protobuf, any feedback?

@Logofile
Copy link
Contributor

Logofile commented Mar 6, 2023

The content looks sound from my experience rolling out protobuf.dev. Thanks for the contribution, Andreas!

@chalin
Copy link
Collaborator

chalin commented Mar 6, 2023

Yes, will have a look shortly.

@deining
Copy link
Collaborator Author

deining commented Jun 11, 2023

Yes, will have a look shortly.

@chalin: friendly ping
I just rebased my PR and resolved existing merge conflicts. My already approved PR is now read for final review and eventual merging. 😄

@chalin chalin added this to the 23Q2 milestone Jun 11, 2023
@chalin chalin modified the milestones: 23Q2, 23Q3 Jul 27, 2023
@chalin chalin modified the milestones: 23Q3, 23Q4 Nov 3, 2023
@deining deining force-pushed the deploy-gh-pages branch 2 times, most recently from 8f36d9b to d34960f Compare November 20, 2023 19:59
@chalin chalin modified the milestones: 23Q4, 24Q1 Jan 11, 2024
@chalin chalin modified the milestones: 24Q1, 24Q2 Apr 2, 2024
@deining
Copy link
Collaborator Author

deining commented May 3, 2024

Yes, will have a look shortly.

@chalin: friendly ping I just rebased my PR and resolved existing merge conflicts. My already approved PR is now read for final review and eventual merging. 😄

@chalin: friendly ping again.
Just rebased this PR again and brought all information and versions up to date.
This info was just requested in #1975, so I would really like to see this merged shortly.

Copy link
Collaborator

@chalin chalin left a comment

Choose a reason for hiding this comment

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

Thanks for the new GH pages section. I haven't stepped through the process, but overall LGTM. Thanks for your input @Logofile.

There are various ways to configure Netlify. The suggested docs section, which you partially updated, describes only one way. IMHO we shouldn't be telling people how to configure their Netlify accounts, instead we should refer them to the Netlify docs and/or to other resources. Since this is a tangential change and issue to this PR, we can address this later.

@chalin chalin mentioned this pull request May 31, 2024
25 tasks
@chalin chalin merged commit cd5e4d0 into google:main May 31, 2024
11 checks passed
@chalin
Copy link
Collaborator

chalin commented May 31, 2024

I'm aware that the link to the "sample workflow" is invalid. We'll address that separately. There is value in publishing this even if the sample workflow file isn't immediately available.

@deining deining deleted the deploy-gh-pages branch May 31, 2024 19:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
user guide Improvements to user guide
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants