[improve][doc] add developers-landing page #17284
Conversation
The Pulsar for Developers content block on the documentation landing page needs to link to this page.
|
Preview looks good.
|
github-actions
bot
added
the
doc
There was a problem hiding this comment.
Thanks for your contribution!
Please refer to #17272 to update your PR.
|
@momo-jun, could you approve this please? Thank you! |
|
@DaveDuggins since this page seems a standalone page, could you share a screen recording about how users jump to this page? |
|
Hi everyone - I'm not clear as to why this is still stuck. None of these checks are related to documentation. |
|
I've approved to run these tests. They are running now. |
You will only come to this page if you click the Pulsar for Developers box on the documentation landing page. Its purpose is to provide outbound links to related topics. It won't be linked in left-hand navigation. There are several other landing pages like this in development. I'll be posting them in the next week or so. |
|
@Anonymitaet @momo-jun Could you please review? |
There was a problem hiding this comment.
I suggest you submit another PR to make changes to the getting-started-standalone page so that we don't block add the developers-landing page. They're two topics.
Right now I agree on wording changes on the getting-started-standalone page , but second @Anonymitaet's comment #17284 (comment) and have one more question #17284 (comment)
I hadn't intended for all these changes to be together in a single PR. I am still learning how to use Git. I apologize for any confusion. |
|
While I understand that this PR addresses two different pages, from what I've read splitting a PR is problematic. I'd prefer to go ahead and merge this as is. @Anonymitaet @Anonymitaet @momo-jun Thoughts? |
There was a problem hiding this comment.
@DaveDuggins currently we still have some open conversations. Splitting PRs helps we merge patches independently. If you don't mind the coupling, I'm OK to review these two as a whole.
I send two suggestions that's blocker to me from approving this patch. You can read this doc to apply it from web UI.
If you're not yet familiar with Git and the GitHub workflow, please contact me and I can prepare the patch on behalf of you and retain your credits.
Co-authored-by: tison <[email protected]>
Co-authored-by: tison <[email protected]>
|
@momo-jun, could you please do a final review and merge this PR if everything looks good? Thank you! |
|
After discussing with Dawn, I have further clarification on the issue of using h2 paragraph headers as steps. It is good for blog posts but is not used in technical writing. It does not conform to the Information Architecture agreed on by the community. h2 is for topic subheadings and procedure titles. This example conforms to our IA: https://docs.google.com/document/d/1rKmmJ5oj-fiK2uwYScqU7aiOys7q-fTjjJeLPCZcxfI/edit |
|
@tisonkun @Anonymitaet have your concerns been addressed? |
Motivation
The Pulsar for Developers content block on the documentation landing page needs to link to this page.
Modifications
Add developers-landing.md
Verifying this change
Documentation
Check the box below or label this PR directly.
Need to update docs?
doc-required(Your PR needs to update docs and you will update later)
doc-not-needed(Please explain why)
doc(Your PR contains doc changes)
doc-complete(Docs have been already added)