Opened 3 years ago
Closed 2 years ago
#6338 closed enhancement (fixed)
List the documentation handbook on devhub
Reported by: | TJNowell | Owned by: | tellyworth |
---|---|---|---|
Milestone: | Priority: | high | |
Component: | Developer Hub | Keywords: | has-patch |
Cc: |
Description
On developers.wordpress.org there is no link to the documentation handbook, or any references to the doc teams documentation.
I would suggest a link be added to https://make.wordpress.org/docs/handbook/ at the bottom of the page underneath the contribute title.
If it requires a code change then I'm happy to do the change myself if possible, but I will need guidance for where to go and what the process is.
Attachments (2)
Change History (14)
This ticket was mentioned in Slack in #docs by tomjn. View the logs.
3 years ago
This ticket was mentioned in Slack in #meta by tellyworth. View the logs.
3 years ago
#4
@
3 years ago
Yes! Though that's mostly a suggestion, if you feel it would fit somewhere else on that page better that's fine. The main issue is that it is not linked anywhere and isn't discoverable.
#5
follow-up:
↓ 8
@
3 years ago
- Keywords has-patch added
I am at WCEU right now and looked into this. I talked to Milana Cap @milana_cap on the documentation team, and we were able to determine that all of the content on this page is controlled by widgets, except for this box. The relevant code is in meta.git.wordpress.org/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/page-home-landing.php
<?php <div class="search-guide inner-wrap section"> <?php if ( is_active_sidebar( 'landing-footer-1') ) { ?> <?php dynamic_sidebar( 'landing-footer-1' ); ?> <?php } else { ?> <div class=" box"></div> <?php } ?> <div class="box"> <h3 class="widget-title"><?php _e( 'Contribute', 'wporg' ); ?></h3> <ul class="unordered-list no-bullets"> <li><a href="https://make.wordpress.org/" class="make-wp-link"><?php _e( 'Help Make WordPress', 'wporg' ); ?></a></li> </ul> </div> <?php if ( is_active_sidebar( 'landing-footer-2') ) { ?> <?php dynamic_sidebar( 'landing-footer-2' ); ?> <?php } else { ?> <div class=" box"></div> <?php } ?> </div>
I suggest that we make a new dynamic_sidebar 'landing-footer-3', so that we can then modify the content there without having to make code changes. I am attaching a diff which does this (leaving the landing-footer-2 as is, though re-naming it "footer right", since it is actually on the right side.
#6
@
3 years ago
I'm also at WCEU Contributor Day; I agree with @robfelty's approach to convert this to a widget that can be edited without a code change going forward.
@robfelty, one question for you: do you plan to submit a second diff to remove the else condition and the code within it from wordpress.org/public_html/wp-content/themes/pub/wporg-developer/page-home-landing.php
once the widget has been created and placed into the correct location?
#7
@
3 years ago
Thanks for the question Ryan. Yes, I kept the existing behavior in the else clause, so that it will work while someone is adding widget(s) to the new sidebar. We can get rid of it once the widgets have been added. Another option would be to just leave it broken for a short time while we put the widgets in, but that would require more synchronous coordination, so I'd rather do it in two steps.
#8
in reply to:
↑ 5
@
3 years ago
Replying to robfelty:
I suggest that we make a new dynamic_sidebar 'landing-footer-3', so that we can then modify the content there without having to make code changes. I am attaching a diff which does this (leaving the landing-footer-2 as is, though re-naming it "footer right", since it is actually on the right side.
Hi there, thanks for the patch! This looks good to me, but I think we can also rename the IDs so that they go sequentially from 1 to 3, to avoid confusion. What's currently in landing-footer-2
can then be moved to landing-footer-3
, and the "Help Make WordPress" link can be added to landing-footer-2
. Commit incoming :)
#10
follow-up:
↓ 11
@
3 years ago
The widget areas were updated, and a link to the Documentation Contributor Handbook has been added to the Contribute section. I believe this resolves the ticket?
#11
in reply to:
↑ 10
@
3 years ago
Replying to SergeyBiryukov:
The widget areas were updated, and a link to the Documentation Contributor Handbook has been added to the Contribute section. I believe this resolves the ticket?
Yes, I just checked it in dashboard.
Thank you to all who contributed to making this possible <3
To clarify, you mean adding that link to the main index page on https://developer.wordpress.org/ right?