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(7): Containerize your app: how Uber moves big data in hours #66

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

hunxjunedo
Copy link
Contributor

fixes #7
/claim #7

This article has the following advantages:

  • the content is formed by summarizing key points from the blogs of these companies to ensure accurate facts
  • considerable time and effort invested on researching and summarizing the content for case studies
  • the case studies are shaped in a way that appeals to the target audience
  • case studies are used to support the arguments throughout the article
  • the benefits are written in a straight-forward way, eliminating any ambiguity

therefore I request to be assigned, I'm open to making any changes suggested

Writer's Checklist

Writing Structure

  • Use short sentences and paragraphs, and include bucket brigades.
  • Include more than two descriptive H2 headings to organize content.
  • Capitalize headings according to the AP Stylebook (use this tool)
  • Include an introduction with at least two paragraphs before the first H2 section.
  • Use appropriate formatting (bold, italic, underline), notes, quotes, TLDRs, and key points.
  • Incorporate code elements and Markdown format where appropriate.
  • Ensure at least one visual element per “screen” of the article (screenshots, diagrams, tables, graphs, lists, sidenotes, blockquotes).

Fact-Checking

  • Verify all facts and data points included in the article.

Asset Management

  • Save images in the /assets folder.
  • Follow naming conventions: YYYYMMDD_title_of_the_article_IMG_NAME_NO.png.
  • (Optional) Create a GitHub repo for the code referenced in the article and share it.
  • (Optional) Include a link to this Loom video in the PR comments.

Interlinking

Glossary/Definitions

  • Create new definition in /defitnitions folder.

Review and Edit

  • Ensure articles address the needs of the target audience and their search intent.
  • Read the article out loud to catch any awkward phrasing.
  • Run the draft through Grammarly or a similar grammar tool.
  • Double-check adherence to the style guide and repository guidelines.
  • Use the name of the article for the title of the PR.

@hunxjunedo
Copy link
Contributor Author

@nkkko are we moving towards assigning and finalizing this one ?

Copy link
Member

@nkkko nkkko left a comment

Choose a reason for hiding this comment

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

This gives me mixed feelings. Are you sure those are appropriate examples. I am not convinced by your article. Also you use Uber in the title, but that is just one of your examples. You should have invested more effort.

@hunxjunedo
Copy link
Contributor Author

hunxjunedo commented Sep 10, 2024

@nkkko one thing I'm confident about is the authenticity and relevance of these examples. I've read companies own published blogs like Netflix and Uber, which released it in context of containerization itself, and it took significant effort and time. I've also added the references for further confirmation.

I will work on the title, please tell what else needs changes, will be more than happy to improve.

@hunxjunedo
Copy link
Contributor Author

@mojafa what is the update on this one ? There was no response on this, should I close this PR ? This took significant research and effort.

@mojafa
Copy link
Collaborator

mojafa commented Nov 28, 2024

@hunxjunedo Please gimme till end of day to get back on this. I'll rereview it

@hunxjunedo
Copy link
Contributor Author

@mojafa hey, any luck with that?

@mojafa
Copy link
Collaborator

mojafa commented Dec 2, 2024

@hunxjunedo here are my comments:

  1. the issue name is Real-World Applications of Containerized Development: Case Studies and Lessons Learned
    please ensure your title covers that not Uber only. May be Real-World Applications of Containerized Development: How Uber, Pinterest, Netflix, and Airbnb Leverage Containers

  2. you failed to address :

Insights into team workflows, onboarding processes, and long-term benefits.

  1. There are no refrences in your article.

  2. Highlight Key Points, use callout boxes or TL;DR . Please follow the sample. https://github.com/daytonaio/content/blob/main/articles/YYYYMMDD_article_template.md

  3. Use Grammarly or Hemingway to check the flow and cohesion of your article. Also this is. technical article, please check your language, ensure it meets teh standards. Sentences like the one below are just not it:
    Screenshot 2024-12-02 at 17 28 48

Please put in more effort and finalise this

@hunxjunedo
Copy link
Contributor Author

hunxjunedo commented Dec 3, 2024

@mojafa I've made the requested changes, to be more specific:

  • control the tone throughout the article using Grammarly
  • add TL;DR and rearrange the structure
  • add references
  • add the missed parts
  • update the title

please feel free to request more changes in the loop!

@mojafa
Copy link
Collaborator

mojafa commented Dec 4, 2024

@hunxjunedo I wanted to let you know that I've just pushed some changes to the main branch that fix some linting issues and update the compliance rules. These updates should help you pass the content compliance checks in your current pull request.

When you get a chance, please pull the latest changes from the main branch into your working branch. This should make the integration smoother and help avoid any potential conflicts.

@mojafa
Copy link
Collaborator

mojafa commented Dec 4, 2024

Screenshot 2024-12-05 at 02 41 00 still seeing Uber in the title. You don't talk about Uber alone. You have pinterest, airbnb, netflix as well no?

@hunxjunedo
Copy link
Contributor Author

@mojafa , terribly sorry about the title in the metadata, really forgot to remove that.

mojafa and others added 4 commits December 5, 2024 14:48
Signed-off-by: Jaafar <[email protected]>
Signed-off-by: hunxjunedo <[email protected]>
Signed-off-by: Jaafar <[email protected]>
Signed-off-by: hunxjunedo <[email protected]>
Signed-off-by: Jaafar <[email protected]>
Signed-off-by: hunxjunedo <[email protected]>
Signed-off-by: hunxjunedo <[email protected]>
@hunxjunedo
Copy link
Contributor Author

@mojafa This one's ready, however, I had to add line breaks to make lint pass, dk how that's supposed to work.

@hunxjunedo
Copy link
Contributor Author

@mojafa can we finalize this one ? Is the quality unsatisfactory?

@mojafa
Copy link
Collaborator

mojafa commented Dec 8, 2024

@hunxjunedo we're not there yet. also the tone of the article is not as technical. Can I close this PR while you pick up another issue? There's two other submissions doe this issue

@hunxjunedo
Copy link
Contributor Author

hunxjunedo commented Dec 8, 2024

@mojafa It's up to you, but there is a reason for the tone to not be technical, I wrote a bunch of articles for Tailcall, and the devrel actually suggested to make the tone less-controlled, and it worked great for them, should work for you!

@mojafa
Copy link
Collaborator

mojafa commented Dec 8, 2024

I've asked Niko about this issue.

The issue topic is wide, and all three PRs (yours included) address different companies and what not. I'll get back to you.

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

Successfully merging this pull request may close these issues.

Real-World Applications of Containerized Development: Case Studies and Lessons Learned
3 participants