Changeset 5768

Timestamp:

08/07/2017 08:46:56 PM (7 years ago)

Author:

danielbachhuber

Message:

devhub/cli: Add "Contributing" section to bottom of command docs

Location:

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer

Files:

• content-command.php (modified) (1 diff)
• inc/cli.php (modified) (3 diffs)
• scss/main.scss (modified) (2 diffs)
• stylesheets/main.css (modified) (2 diffs)

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/content-command.php

@@ -20 +20 @@
 
     <footer class="entry-meta">
-        <p><em>Command documentation is regenerated at every release. To add or update an example, please submit a pull request against the corresponding part of the codebase.</em></p>
-
         <?php edit_post_link( __( 'Edit', 'wporg' ), '<span class="edit-link">', '</span>' ); ?>
     </footer><!-- .entry-meta -->

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/cli.php

@@ -267 +267 @@
         $content = str_replace( '-–', '---', $content );
 
-        // Append subcommands if they exist
         $children = get_children( array(
             'post_parent'    => get_the_ID(),
@@ -275 +274 @@
             'order'          => 'ASC',
         ) );
+        // Append subcommands if they exist
         if ( $children ) {
             ob_start();
@@ -300 +300 @@
         }
 
+        $contributing_bits = array();
+        $repo_url = get_post_meta( get_the_ID(), 'repo_url', true );
+        $cmd_slug = str_replace( 'wp ', '', get_the_title() );
+        $open_issues = 'https://github.com/issues?q=label%3A' . urlencode( 'command:' . str_replace( ' ', '-', $cmd_slug ) ) . '+sort%3Aupdated-desc+org%3Awp-cli+is%3Aopen';
+        $closed_issues = 'https://github.com/issues?q=label%3A' . urlencode( 'command:' . str_replace( ' ', '-', $cmd_slug ) ) . '+sort%3Aupdated-desc+org%3Awp-cli+is%3Aclosed';
+        ob_start();
+        ?>
+        <div class="github-tracker">
+            <?php if ( $repo_url ) : ?>
+                <a href="<?php echo esc_url( $repo_url ); ?>"><img src="https://make.wordpress.org/cli/wp-content/plugins/wporg-cli/assets/images/github-mark.svg" class="icon-github" /></a>
+                <a href="<?php echo esc_url( rtrim( $repo_url, '/' ) . '/issues/new' ); ?>" class="button">Create New Issue</a>
+            <?php endif; ?>
+            <div class="btn-group">
+                <a href="<?php echo esc_url( $open_issues ); ?>" class="button">View Open Issues</a>
+                <a href="<?php echo esc_url( $closed_issues ); ?>" class="button">View Closed Issues</a>
+            </div>
+        </div>
+        <?php
+        $issues = ob_get_clean();
+        $contributing_bits[] = $issues;
+        $contributing_bits[] = '<p>Command documentation is regenerated at every release. To add or update an example, please submit a pull request against the corresponding part of the codebase.</p>';
+        $contributing_bits[] = '<p>See <a href="https://make.wordpress.org/cli/handbook/contributing/">contributing guidelines</a> for full details on contributing.</p>';
+
+        $contributing = '<h3>CONTRIBUTING</h3>' . PHP_EOL . implode( PHP_EOL, $contributing_bits );
+        $content .= $contributing;
+
         // Add 'Quick Links' across the top
         $items = self::get_tags( 'h([1-4])', $content );

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/scss/main.scss

@@ -1881 +1881 @@
 
     h2, h3 {
-        margin-top: 3rem;
+        margin-top: 4rem;
         margin-bottom: 2.5rem;
         font-size: 2.5rem;
@@ -1943 +1943 @@
     }
 }
+
+.single-command {
+    .devhub-wrap *, .devhub-wrap *::before, .devhub-wrap *::after {
+        -moz-box-sizing: border-box;
+        -webkit-box-sizing: border-box;
+        box-sizing: border-box;
+    }
+
+    .devhub-wrap a.button, .devhub-wrap button, .devhub-wrap input[type="button"], .devhub-wrap input[type="reset"], .devhub-wrap input[type="submit"] {
+        border: 1px solid;
+        border-color: #ccc;
+        border-radius: 3px;
+        background: #f7f7f7;
+        color: rgba(0, 0, 0, 0.8);
+        cursor: pointer;
+        font-size: 1.2rem;
+        line-height: 1;
+        float: none;
+        height: auto;
+        padding: .8rem 1.2rem;
+        margin: .4rem 0;
+        text-decoration: none;
+        -webkit-appearance: button;
+
+        &:hover {
+            border-color: #ccc #bbb #aaa #bbb;
+            background: #eee;
+        }
+        
+        &:focus, &:active {
+            border-color: #bbb;
+            background: #eee;
+            -webkit-box-shadow: 0 0 4px rgba(0, 0, 0, 0.2);
+            box-shadow: 0 0 4px rgba(0, 0, 0, 0.2);
+        }
+        
+        > span {
+            color: #757575;
+            line-height: 1;
+            font-size: .7rem;
+            
+            &.red {
+                color: #dc3232;
+            }
+            &.green {
+                color: #46B450;
+            }
+        }
+
+    }
+
+    .btn-group {
+        display: inline;
+        
+        > button {
+            position: relative;
+            
+            &:first-child {
+                @media(min-width: 571px) {
+                    right: -6px;
+                    border-radius: 3px 0 0 3px;
+                }
+            }
+            &:last-child {
+                @media(min-width: 571px) {
+                    border-radius: 0 3px 3px 0;
+                }
+            }
+        }
+    }
+
+    .github-tracker {
+        margin-bottom: 1.5em;
+        img.icon-github {
+            width: 23px;
+            position: relative;
+            top: 6px;
+            margin-right: 5px;
+        }
+    }
+}

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/stylesheets/main.css

@@ -2195 +2195 @@
 
 .single-command #content h2, .single-command #content h3 {
-  margin-top: 3rem;
+  margin-top: 4rem;
   margin-bottom: 2.5rem;
   font-size: 2.5rem;
@@ -2256 +2256 @@
   background: rgba(0, 0, 0, 0.025);
 }
+
+.single-command .devhub-wrap *, .single-command .devhub-wrap *::before, .single-command .devhub-wrap *::after {
+  -moz-box-sizing: border-box;
+  -webkit-box-sizing: border-box;
+  box-sizing: border-box;
+}
+
+.single-command .devhub-wrap a.button, .single-command .devhub-wrap button, .single-command .devhub-wrap input[type="button"], .single-command .devhub-wrap input[type="reset"], .single-command .devhub-wrap input[type="submit"] {
+  border: 1px solid;
+  border-color: #ccc;
+  border-radius: 3px;
+  background: #f7f7f7;
+  color: rgba(0, 0, 0, 0.8);
+  cursor: pointer;
+  font-size: 1.2rem;
+  line-height: 1;
+  float: none;
+  height: auto;
+  padding: .8rem 1.2rem;
+  margin: .4rem 0;
+  text-decoration: none;
+  -webkit-appearance: button;
+}
+
+.single-command .devhub-wrap a.button:hover, .single-command .devhub-wrap button:hover, .single-command .devhub-wrap input[type="button"]:hover, .single-command .devhub-wrap input[type="reset"]:hover, .single-command .devhub-wrap input[type="submit"]:hover {
+  border-color: #ccc #bbb #aaa #bbb;
+  background: #eee;
+}
+
+.single-command .devhub-wrap a.button:focus, .single-command .devhub-wrap a.button:active, .single-command .devhub-wrap button:focus, .single-command .devhub-wrap button:active, .single-command .devhub-wrap input[type="button"]:focus, .single-command .devhub-wrap input[type="button"]:active, .single-command .devhub-wrap input[type="reset"]:focus, .single-command .devhub-wrap input[type="reset"]:active, .single-command .devhub-wrap input[type="submit"]:focus, .single-command .devhub-wrap input[type="submit"]:active {
+  border-color: #bbb;
+  background: #eee;
+  -webkit-box-shadow: 0 0 4px rgba(0, 0, 0, 0.2);
+  box-shadow: 0 0 4px rgba(0, 0, 0, 0.2);
+}
+
+.single-command .devhub-wrap a.button > span, .single-command .devhub-wrap button > span, .single-command .devhub-wrap input[type="button"] > span, .single-command .devhub-wrap input[type="reset"] > span, .single-command .devhub-wrap input[type="submit"] > span {
+  color: #757575;
+  line-height: 1;
+  font-size: .7rem;
+}
+
+.single-command .devhub-wrap a.button > span.red, .single-command .devhub-wrap button > span.red, .single-command .devhub-wrap input[type="button"] > span.red, .single-command .devhub-wrap input[type="reset"] > span.red, .single-command .devhub-wrap input[type="submit"] > span.red {
+  color: #dc3232;
+}
+
+.single-command .devhub-wrap a.button > span.green, .single-command .devhub-wrap button > span.green, .single-command .devhub-wrap input[type="button"] > span.green, .single-command .devhub-wrap input[type="reset"] > span.green, .single-command .devhub-wrap input[type="submit"] > span.green {
+  color: #46B450;
+}
+
+.single-command .btn-group {
+  display: inline;
+}
+
+.single-command .btn-group > button {
+  position: relative;
+}
+
+@media (min-width: 571px) {
+  .single-command .btn-group > button:first-child {
+    right: -6px;
+    border-radius: 3px 0 0 3px;
+  }
+}
+
+@media (min-width: 571px) {
+  .single-command .btn-group > button:last-child {
+    border-radius: 0 3px 3px 0;
+  }
+}
+
+.single-command .github-tracker {
+  margin-bottom: 1.5em;
+}
+
+.single-command .github-tracker img.icon-github {
+  width: 23px;
+  position: relative;
+  top: 6px;
+  margin-right: 5px;
+}