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

docs: update podman driver documentation #11300

Merged
merged 1 commit into from
Nov 3, 2021
Merged

docs: update podman driver documentation #11300

merged 1 commit into from
Nov 3, 2021

Conversation

lgfa29
Copy link
Contributor

@lgfa29 lgfa29 commented Oct 12, 2021

Update Podman task driver documentation based on latest repo's README.

@lgfa29
Copy link
Contributor Author

lgfa29 commented Oct 12, 2021

@towe75 here is the source code for the Podman documentation in our website. I copied over the new additions from the README and removed the Known Limitations section as they both seemed to be handled.

You can see a preview of the changes here: https://nomad-4298056vy-hashicorp.vercel.app/docs/drivers/podman

@towe75
Copy link
Contributor

towe75 commented Oct 30, 2021

@lgfa29 storing the docs in two places and syncing it manually is tedious and error prone.

Having the docs only here imposes some problems when working on a new driver feature in branches. Having it only in the original repo, however, has the downside that we must sync it periodically.

Personally i would go for a solution at the ci/build-system/release level. Publishing the website would also reformat/embed the documentation from a number of external driver repositories (e.g. latest release per driver). It's fine IMO to require driver authors to inherit some strict documentation format rules or a specific repo layout (e.g. docs/ folder).

I've worked long enough on poly-repos to immediately recognize the underlying pattern. Better to spend a few hours on the ci server.

@lgfa29
Copy link
Contributor Author

lgfa29 commented Nov 2, 2021

Yeah..pulling docs from external repos has been on mind for a while. I know that Packer does it and Terraform also has a way to re-build the registry based on the provider README.

I will need to look into how they work and adapt it into the Nomad website.

In the meantime, I will merge this PR and sync things ad-hoc.

@lgfa29 lgfa29 requested a review from jrasell November 2, 2021 00:11
Copy link
Member

@jrasell jrasell left a comment

Choose a reason for hiding this comment

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

Sorry it took son long, this looks great!

@lgfa29
Copy link
Contributor Author

lgfa29 commented Nov 3, 2021

Sorry it took son long, this looks great!

Not at all, I actually forgot to tag you until very recently 😅

@lgfa29 lgfa29 merged commit 0e3cd60 into main Nov 3, 2021
@lgfa29 lgfa29 deleted the docs-update-podman branch November 3, 2021 15:07
@github-actions
Copy link

I'm going to lock this pull request because it has been closed for 120 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 12, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants