Skip to content

Example update: Getting started with BitOps v2.0 - Terraform#299

Merged
ccapell merged 6 commits intomainfrom
exampleupdate
Sep 9, 2022
Merged

Example update: Getting started with BitOps v2.0 - Terraform#299
ccapell merged 6 commits intomainfrom
exampleupdate

Conversation

@ccapell
Copy link
Copy Markdown
Contributor

@ccapell ccapell commented Sep 8, 2022

Description

Added example for Blogpost
Updated .gitignore

  • added .DS_Store
  • Added .vscode/settings.json

Copy link
Copy Markdown
Contributor

@arm4b arm4b left a comment

Choose a reason for hiding this comment

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

Could you add some README.md for this example?

See other https://github.com/bitovi/bitops/tree/main/docs/examples for inspiration

@ccapell
Copy link
Copy Markdown
Contributor Author

ccapell commented Sep 8, 2022

Added readme

Comment on lines +1 to +5
# Bitops Operations Repo

Welcome to Bitops! This serves as a starting point for deploying your application to the cloud.

This repo can be run as is with
Copy link
Copy Markdown
Contributor

@arm4b arm4b Sep 8, 2022

Choose a reason for hiding this comment

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

Looks similar to https://github.com/bitovi/bitops/tree/main/docs/examples/bitops-deploy-heyemoji/README.md

Could we add at least a few words of specifics what's going on in this example and how it's different compared to others?

For instance, https://github.com/bitovi/bitops/tree/main/docs/examples/terraform-and-ansible is a good one.

That'll make the README for this example unique.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

We can update it after the blog post goes live with the URL to the blog post. This is the example for the blog post. I need to include the link to this repo BEFORE the blog post goes live. Until the blog goes live we won't have the URL. See the issue? I did add a place holder though.

Copy link
Copy Markdown
Contributor

@arm4b arm4b Sep 8, 2022

Choose a reason for hiding this comment

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

I think having a very small brief description of what this example does would be sufficient without failing into the chicken vs egg problem with the blog URL that wasn't posted yet.

Just added a specific code suggestion here: #299 (comment)

@arm4b arm4b changed the title Example update Example update: Getting started with BitOps v2.0 - Terraform Sep 8, 2022
@arm4b arm4b added documentation 📗 Improvements or additions to documentation examples labels Sep 8, 2022
@ccapell ccapell merged commit 77c3884 into main Sep 9, 2022
@ccapell ccapell deleted the exampleupdate branch September 9, 2022 12:33
Copy link
Copy Markdown
Contributor

@PhillypHenning PhillypHenning left a comment

Choose a reason for hiding this comment

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

Looks good to me

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

Labels

documentation 📗 Improvements or additions to documentation examples

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants