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

Create or source missing image files from documentation #15

Open
Yantrio opened this issue Aug 30, 2023 · 2 comments
Open

Create or source missing image files from documentation #15

Yantrio opened this issue Aug 30, 2023 · 2 comments
Labels

Comments

@Yantrio
Copy link
Member

Yantrio commented Aug 30, 2023

Some mdx files are missing images, we should source or create images to replace them.

@Yantrio
Copy link
Member Author

Yantrio commented Aug 31, 2023

So far I've identified 3 missing images:

graph-example.png

Usage: https://github.com/opentffoundation/opentf/blob/a83e5ee5ac71c35886044d22ecf8e6d63e019016/website/docs/cli/commands/graph.mdx#L56C46-L56C46

Description:
A screenshot of an svg generated by the command opentf graph | dot -Tsvg > graph.svg

intro-opentf-apis.png

Usage: https://github.com/opentffoundation/opentf/blob/a83e5ee5ac71c35886044d22ecf8e6d63e019016/website/docs/intro/index.mdx#L16

Description
A small image showing how opentf, providers and the "target API" all work together.

In text form:
OpenTF <--> Terraform Provider <--> Target API

intro-opentf-workflow.png

Usage: https://github.com/opentffoundation/opentf/blob/a83e5ee5ac71c35886044d22ecf8e6d63e019016/website/docs/intro/index.mdx#L26

Description: An image displaying the workflow steps of writing IaC with opentf.

Write -> Plan -> Apply
With some text describing each of the phases, and what they include.

@damianstasik
Copy link
Collaborator

@Yantrio do you think some of these images can be skipped?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants