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

Removing irrelevant example files #361

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

PhillypHenning
Copy link
Contributor

Description

Removing files and folders that contain out-of-date examples.

Please delete options that are not relevant.

  • Documentation update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation

Copy link
Member

@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.

Not sure about this change as there are blogs that refer to examples residing in this repo.

For example, https://www.bitovi.com/blog/devops-automation-using-stackstorm-bitops-infrastructure blog points to https://github.com/bitovi/bitops/tree/main/docs/examples/bitops+terraform+ansible+stackstorm-blog

But I'm sure there might be some examples that don't have blog references that 💯 worth removing.

@mickmcgrath13 your thoughts on that?

@arm4b arm4b added the documentation 📗 Improvements or additions to documentation label Nov 21, 2022
@PhillypHenning
Copy link
Contributor Author

That's true but it still is in the history. Perhaps we can branch + protect and make a note in the README?

@PhillypHenning
Copy link
Contributor Author

Additionally - I just went through our blogs and though yes some blogs certainly point to these. They, to my knowledge, were never really used (didn't lead to conversion) and the blogs themselves didn't do great stats wise.

Recent stats from a quick sampling suggests it's not worth keeping these based on the blogs as they aren't really popular anyways.

Copy link
Contributor

@mickmcgrath13 mickmcgrath13 left a comment

Choose a reason for hiding this comment

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

@PhillypHenning A lot of these that are being removed would be valuable for future blog posts (bitops-fast-react-static-renderer, for example), and in the bitops+terraform+ansible-blog environment dir not being referenced from connor's blog?

@mickmcgrath13
Copy link
Contributor

sorry, just properly caught up on the conversation in this thread.

  • I don't think we should remove the ones referenced by blogs. I'm not convinced these links in blogs are contributing to the lack of conversion, and IMO, more info is better.
  • I also think we should put the ones being removed somewhere for safe-keeping. If that's a branch, I'd say we need to have an easy-to-find link to be able to find them. Would it make sense to move them to our internal ops repo examples repo until we can turn them into a GHA, write a blog about them, etc.?

@arm4b
Copy link
Member

arm4b commented Dec 8, 2022

bitops-archive or bitops-examples?

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants