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

blog: Feedback on cargo-info to prepare it for merging #108

Merged
merged 14 commits into from
Feb 22, 2024

Conversation

Rustin170506
Copy link
Owner

@Rustin170506 Rustin170506 commented Feb 1, 2024

Signed-off-by: hi-rustin <rustin.liu@gmail.com>
Signed-off-by: hi-rustin <rustin.liu@gmail.com>
Signed-off-by: hi-rustin <rustin.liu@gmail.com>
Signed-off-by: hi-rustin <rustin.liu@gmail.com>
Signed-off-by: hi-rustin <rustin.liu@gmail.com>
Signed-off-by: hi-rustin <rustin.liu@gmail.com>
Signed-off-by: hi-rustin <rustin.liu@gmail.com>
Signed-off-by: hi-rustin <rustin.liu@gmail.com>
Signed-off-by: hi-rustin <rustin.liu@gmail.com>
Signed-off-by: hi-rustin <rustin.liu@gmail.com>
@Rustin170506
Copy link
Owner Author

cc: @epage Would you like to review the document before it's posted on the internal forum? If you're short on time, you can also provide feedback after publication. Thanks in advance.

@epage
Copy link
Contributor

epage commented Feb 5, 2024

rendered

@epage
Copy link
Contributor

epage commented Feb 5, 2024

I went ahead and did #109 real quick but overall, I think the question is what is your goal.

epage and others added 2 commits February 6, 2024 00:15
Signed-off-by: hi-rustin <rustin.liu@gmail.com>
@Rustin170506
Copy link
Owner Author

  • This is titled as a Pre-RFC but we don't generally use RFCs for subcommands. Instead, we use a form of a change proposal.

Thanks! I forgot it. I've changed the title of this blog.

I think the question is what is your goal?

I want to focus on getting feedback on the unknown or uncertain designs and issues. I should emphasize the goal at the beginning or I may have too many details in this blog. What do you think? Should we put that many details in it or not?

@Rustin170506 Rustin170506 changed the title blog: cargo-information pre-RFC blog: Feedback on cargo-info to prepare it for merging Feb 18, 2024
@epage
Copy link
Contributor

epage commented Feb 19, 2024

I want to focus on getting feedback on the unknown or uncertain designs and issues. I should emphasize the goal at the beginning or I may have too many details in this blog. What do you think? Should we put that many details in it or not?

Would Internals be a better place, than your blog?

So the goal (and now title) is about feedback but the structure doesn't show that.

For cargo add and cargo upgade,

  • Opened with a very brief piece of context (related issue, that I'm looking for feedback)
  • Provided a brief summary of what is done today titled "background". The title is important. "Summary" makes it sound like it'll be about your post. "Background" makes it clear that you are providing context for the questions you want answered.
  • The background section is brief. I did this by focusing on the screenshot and then calling out some non-obvious points
  • The remainder should be focused on the areas of concern with what context you can provide

@Rustin170506
Copy link
Owner Author

Would Internals be a better place, than your blog?

Yes, I will post it in the Internals. I utilize this blog as a platform to review the code(content) before publishing it.

Signed-off-by: hi-rustin <rustin.liu@gmail.com>
Signed-off-by: hi-rustin <rustin.liu@gmail.com>
@Rustin170506
Copy link
Owner Author

@epage I updated it again. I deleted the scenario demos. Mentioned some background on the command. Also emphasized that I want to discuss those issues that are still undecided. Do you think this is ok for now?

@Rustin170506
Copy link
Owner Author

I am going to merge this PR. I will publish it on internals later and if you have anything want to add I think you can comment on the internals forum.

Thanks for your review!

@Rustin170506 Rustin170506 merged commit 9690e76 into master Feb 22, 2024
@Rustin170506 Rustin170506 deleted the rustin-patch-blog-cargo-information branch February 22, 2024 12:15
@Rustin170506
Copy link
Owner Author

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

Successfully merging this pull request may close these issues.

2 participants