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

docs: add language specific guide for c++ #19903

Merged
merged 15 commits into from
Jun 5, 2024
Merged

docs: add language specific guide for c++ #19903

merged 15 commits into from
Jun 5, 2024

Conversation

Pradumnasaraf
Copy link
Contributor

Description

  • Add language specific guide for c++

Related issues or tickets

fix #19898

Reviews

  • Technical review
  • Editorial review
  • Product review

@github-actions github-actions bot added the area/get-started Relates to get started and onboarding docs label Apr 27, 2024
@netlify Netlify
Copy link

netlify bot commented Apr 27, 2024 •
edited

✅ Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 89f5942
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/66608ec015f801000813e3af
😎 Deploy Preview https://deploy-preview-19903--docsdocker.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@craig-osterhout
Copy link
Contributor

Hi @Pradumnasaraf,
Thank you!
We'll definitely work on getting this added.
I haven't had time to do a full review, but a few quick things:

  • You can add the topics to the left navigation by updating the data/toc.yaml file
  • It looks like there's a validation error in the content/language/_index.md file related to the link. Your folder name is c++, but the link is c-plus-plus.

@Pradumnasaraf
Copy link
Contributor Author

Hey, @craig-osterhout.

Thank you for the feedback. I have updated the docs as you requested.

@Pradumnasaraf
Copy link
Contributor Author

Hey,
Let me know if you need any help with the PR.

craig-osterhout
craig-osterhout requested changes May 24, 2024
View reviewed changes
Copy link
Contributor

@craig-osterhout craig-osterhout left a comment

Choose a reason for hiding this comment

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

Thanks again @Pradumnasaraf for your contribution. I left some review comments.
Also, feel free to add an acknowledgement callout for yourself like https://github.com/docker/docs/blob/main/content/language/golang/_index.md?plain=1#L11

content/language/c-plus-plus/containerize.md Outdated Show resolved Hide resolved
content/language/c-plus-plus/containerize.md Outdated Show resolved Hide resolved
content/language/c-plus-plus/containerize.md Outdated Show resolved Hide resolved
content/language/c-plus-plus/containerize.md Outdated Show resolved Hide resolved
content/language/c-plus-plus/containerize.md Outdated Show resolved Hide resolved
content/language/c-plus-plus/develop.md Outdated Show resolved Hide resolved
content/language/c-plus-plus/configure-ci-cd.md Outdated Show resolved Hide resolved
content/language/c-plus-plus/containerize.md Outdated
Clone the sample application to use with this guide. Open a terminal, change directory to a directory that you want to work in, and run the following command to clone the repository:

```console
$ git clone https://github.com/Pradumnasaraf/c-plus-plus-docker.git
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we fork your repo to a Docker-controlled repo and update this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, go ahead, Craig.

@craig-osterhout craig-osterhout requested a review from a team May 24, 2024 21:08
Pradumnasaraf and others added 8 commits May 25, 2024 18:31
@Pradumnasaraf @craig-osterhout
Update content/language/c-plus-plus/containerize.md
5a9adbd 
Co-authored-by: Craig Osterhout <103533812+craig-osterhout@users.noreply.github.com>
@Pradumnasaraf @craig-osterhout
Update content/language/c-plus-plus/containerize.md
149149a 
Co-authored-by: Craig Osterhout <103533812+craig-osterhout@users.noreply.github.com>
@Pradumnasaraf @craig-osterhout
Update content/language/c-plus-plus/containerize.md
9f50c2e 
Co-authored-by: Craig Osterhout <103533812+craig-osterhout@users.noreply.github.com>
@Pradumnasaraf @craig-osterhout
Update content/language/c-plus-plus/containerize.md
1baaee9 
Co-authored-by: Craig Osterhout <103533812+craig-osterhout@users.noreply.github.com>
@Pradumnasaraf @craig-osterhout
Update content/language/c-plus-plus/containerize.md
4849506 
Co-authored-by: Craig Osterhout <103533812+craig-osterhout@users.noreply.github.com>
@Pradumnasaraf @craig-osterhout
Update content/language/c-plus-plus/develop.md
692ff01 
Co-authored-by: Craig Osterhout <103533812+craig-osterhout@users.noreply.github.com>
@Pradumnasaraf @craig-osterhout
Update content/language/c-plus-plus/configure-ci-cd.md
03b4cc7 
Co-authored-by: Craig Osterhout <103533812+craig-osterhout@users.noreply.github.com>
@Pradumnasaraf
Update _index.md
f4cf8f7
@Pradumnasaraf
Copy link
Contributor Author

Hey @craig-osterhout, thanks for the review. I have addressed all of them.
Also, I have added an acknowledgement callout, thanks for that.

@dvdksn
guides: use /cpp instead of /c-plus-plus
ae18a8f 
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
@dvdksn
Copy link
Contributor

dvdksn commented May 27, 2024

Hello. I just pushed a small change to use a different, shorter subpath for this guide: from /c-plus-plus to /cpp

@Pradumnasaraf
Copy link
Contributor Author

Hey,
I hope I have made all the required changes. Let me know if I missed anything or if you need any help with the PR.

dvdksn
dvdksn reviewed Jun 3, 2024
View reviewed changes
Copy link
Contributor

@dvdksn dvdksn left a comment

Choose a reason for hiding this comment

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

@craig-osterhout did you already start moving this repo to dockersamples?

content/language/cpp/develop.md Outdated Show resolved Hide resolved
@Pradumnasaraf @dvdksn
Update content/language/cpp/develop.md
aa408bf 
Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
@Pradumnasaraf
Copy link
Contributor Author

Thanks for the suggestion, @dvdksn. Fixed it.

@craig-osterhout
Copy link
Contributor

@craig-osterhout did you already start moving this repo to dockersamples?

I just reached out to devrel to see if they can help fork it. I don't have permissions for the dockersamples org. I'll update here when I hear back.

@Pradumnasaraf @craig-osterhout
Update content/language/cpp/containerize.md
89f5942 
Co-authored-by: Craig Osterhout <103533812+craig-osterhout@users.noreply.github.com>
@Pradumnasaraf
Copy link
Contributor Author

Updated the link, @craig-osterhout. Thank you!

craig-osterhout
craig-osterhout approved these changes Jun 5, 2024
View reviewed changes
Copy link
Contributor

@craig-osterhout craig-osterhout left a comment

Choose a reason for hiding this comment

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

🚀
Thank you.

@craig-osterhout craig-osterhout merged commit 1b6a6d5 into docker:main Jun 5, 2024
11 checks passed
@Pradumnasaraf
Copy link
Contributor Author

Pradumnasaraf commented Jun 5, 2024 •
edited

Thank you for the merge, Craig. Did the chnages take some time to go live?

@Pradumnasaraf Pradumnasaraf deleted the add-c-plus-plus-docs branch June 5, 2024 16:39
@dvdksn
Copy link
Contributor

dvdksn commented Jun 5, 2024

@Pradumnasaraf I kicked the publishing workflow now, the guide should be up on the website in a few minutes! 🎉

Thank you for contributing this guide!

@Pradumnasaraf
Copy link
Contributor Author

@Pradumnasaraf I kicked the publishing workflow now, the guide should be up on the website in a few minutes! 🎉

Thank you for contributing this guide!

Ah, okay. I thought something was broken this is why asked haha. Thank you, @dvdksn, as well for the reviewing :)

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

@dvdksn dvdksn dvdksn left review comments

@craig-osterhout craig-osterhout craig-osterhout approved these changes

Assignees
No one assigned
Labels
area/get-started Relates to get started and onboarding docs status/review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add language specific guide for C++
3 participants
@Pradumnasaraf @craig-osterhout @dvdksn