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

[CI:DOCS] Add documentation for podman with VS Code [WIP] #15254

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/source/Tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Tutorials
Here are a number of useful tutorials to get you up and running with Podman. If you are familiar with the Docker `Container Engine`_ the command in Podman_ should be quite familiar. If you are brand new to containers, take a look at our `Introduction`.

* `Basic Setup and Use of Podman </~https://github.com/containers/podman/blob/main/docs/tutorials/podman_tutorial.md>`_: Learn how to set up Podman and perform some basic commands with the utility.
* `Podman in VS Code </~https://github.com/containers/podman/blob/main/docs/tutorials/vs_code.md>`_: Set up your project to run Podman inside VS Code.
* `Basic Setup and Use of Podman in a Rootless environment </~https://github.com/containers/podman/blob/main/docs/tutorials/rootless_tutorial.md>`_: The steps required to set up rootless Podman are enumerated.
* `Podman for Windows </~https://github.com/containers/podman/blob/main/docs/tutorials/podman-for-windows.md>`_: A guide to installing and using Podman on Windows.
* `Podman Remote Clients on Mac/Windows </~https://github.com/containers/podman/blob/main/docs/tutorials/mac_win_client.md>`_: Advanced setup for connecting to a remote Linux system using the Podman remote client on Mac and Windows.
Expand Down
4 changes: 4 additions & 0 deletions docs/tutorials/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@

Learn how to set up Podman and perform some basic commands with the utility.

**[Podman in VS Code](vs_code.md)**

Set up your project to run Podman inside VS Code.

**[Basic Setup and Use of Podman in a Rootless environment](rootless_tutorial.md)**

The steps required to set up rootless Podman are enumerated.
Expand Down
26 changes: 26 additions & 0 deletions docs/tutorials/vs_code.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
![PODMAN logo](../../logo/podman-logo-source.svg)

# Podman in VS Code
This tutorial shows you how to set up **development containers** inside VS Code to achieve reproducible builds. In this example we will use a ``devcontainer.json` file that also makes your project compatible with GitHub Codespaces and GitHub Actions, however, these instructions can also work for other project hosting and continuous integration services.

In this example we will be using the common scenario of with GitHub Pages to host your blog using Jekyll.

## Installing Podman and VS Code

For installing or building Podman, please see the [installation instructions](https://podman.io/getting-started/installation).

## THINGS TO ADD TO THIS DOCUMENT

- Set up a SIMPLE Jekyll blog in a new directory (without install the Jekyll command locally!)
- Add dev container file
- Add Containers extension to VS Code
- Run the container to host the blog locally
- Open the blog in the browser
- Further reading: making this work with GitHub Codespaces and GitHub Actions

../../test/README.md)

## More information

For more information on Podman and its subcommands, checkout the asciiart demos on the [README.md](../../README.md#commands)
page.