Contribute - Guidelines for Contributing to PKP Documentation

<!DOCTYPE html> <html lang="en-US"> <title>Contribute - Guidelines for Contributing to PKP Documentation</title> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta property="og:title" content="Contribute - Guidelines for Contributing to PKP Documentation" /> <meta property="og:site_name" content="PKP Docs"> <meta name="description" content="A guide on how to contribute to PKP documentation about OJS, OMP, and OPS software and journal publishing best practices"> <meta property="og:description" content="A guide on how to contribute to PKP documentation about OJS, OMP, and OPS software and journal publishing best practices"> <meta property="og:url" content="http://localhost:4000/contributing/en/"> <link type="text/css" href="/css/book.css" rel="stylesheet" media="all"> <script defer src="/assets/js/smooth-scroll.polyfills.min.js"></script> <script defer src="/assets/js/fontawesome.min.js"></script> <body class="body--withSidebar"> <div class="bookHeader"> <button id="sidebarControl" class="bookHeader__sidebarControl"> <span class="fa fa-bars" aria-hidden="true"></span> <span class="fa fa-times" aria-hidden="true"></span> <span class="-screenReader">Toggle Menu</span> </button> <a class="bookHeader__logo" href="/"> <img src="/img/logo-on-white.png" alt="PKP Docs" class="bookHeader__logoImage"> </a> <div class="bookHeaderTools"> </div> </div> <div class="book"> <a href="#sidebar" class="-screenReader"> Jump to table of contents </a> <div class="book__page"> <div class="book__content"> <div class="book__improve"> <a href="https://github.com/pkp/pkp-docs/edit/main/contributing/en/README.md"> Edit this page </a> or <a href="https://pkp.sfu.ca/documentation-feedback/"> make a suggestion </a> </div> <h1 id="introduction-guidelines-for-contributing-to-pkp-documentation"> Introduction: Guidelines for Contributing to PKP Documentation </h1> <p>This guide explains everything you need to know to contribute to the Public Knowledge Project鈥檚 (PKP鈥檚) documentation, including how to get involved, how to find and complete a documentation task, how to edit and create documentation in PKP鈥檚 GitHub repository, tips on style and formatting, and copyright policies.</p> <p>PKP creates and maintains extensive documentation about our software applications Open Journal Systems (OJS), Open Monograph Press (OMP), and Open Preprint Systems (OPS), as well as on scholarly publishing best practices. All of our documentation is available in the <a href="https://docs.pkp.sfu.ca/index.html">PKP Docs Hub</a> and includes both user guides and videos.</p> <p>These guidelines are for all contributors to our documentation, including PKP staff and committee members, users of the software, journal managers, system administrators, and developers. Whether you are new to PKP software or have been using it for many years, you have a unique perspective and valuable information to share with the community.</p> <p>Documentation is essential to users of Open Journal Systems (OJS), Open Monograph Press (OMP), Open Conference Systems (OCS), and other PKP software. It is often the first thing that users look at when they鈥檙e getting started, trying to troubleshoot a problem, or learning how to use a new feature or version of the software. Creating and updating documentation is a precious contribution to the PKP user community.</p> <hr> <p>Copyright: Simon Fraser University holds the copyright for work produced by the Public Knowledge Project and has placed its documentation under a <a href="https://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.</p> <p><a href="https://creativecommons.org/licenses/by/4.0/"><img src="https://licensebuttons.net/l/by/4.0/88x31.png" alt="Creative Commons Attribution 4.0 International" title="Creative Commons Attribution 4.0 International" /></a></p> <div class="book__footer"> <div class="book__improve"> <a href="https://github.com/pkp/pkp-docs/edit/main/contributing/en/README.md"> Edit this page </a> or <a href="https://pkp.sfu.ca/documentation-feedback/"> make a suggestion </a> </div> </div> </div> </div> <div class="book__sidebarScreen"></div> <div id="sidebar" class="book__sidebar"> <div class="book__summary"> <h1 id="summary">Summary</h1> <ul> <li><a href=".">Introduction</a></li> <li><a href="./contribute">Contribute</a> <ul> <li><a href="./contribute#ways-to-contribute">Ways to Contribute</a></li> <li><a href="./contribute#find-a-documentation-task">Find a Documentation Task</a></li> <li><a href="./contribute#sign-up-for-a-task">Sign up for a Task</a></li> <li><a href="./contribute#contribute-in-other-formats">Contribute in Other Formats</a></li> </ul> </li> <li><a href="./gettingstarted">Getting Started</a> <ul> <li><a href="./gettingstarted#markdown">Markdown</a></li> <li><a href="./gettingstarted#file-structure">File Structure</a></li> <li><a href="./gettingstarted#file-naming-conventions">File Naming Conventions</a></li> <li><a href="./gettingstarted#github-basics">GitHub Basics</a></li> <li><a href="./gettingstarted#editing-on-github">Editing on GitHub</a></li> <li><a href="./gettingstarted#editing-on-the-pkp-docs-hub">Editing on the PKP Docs Hub</a></li> <li><a href="./gettingstarted#editing-with-github-desktop">Editing with GitHub Desktop</a></li> <li><a href="./gettingstarted#contribute-in-other-formats">Contribute in Other Formats</a></li> </ul> </li> <li><a href="./create-and-edit">Create and Edit Documentation</a> <ul> <li><a href="./create-and-edit#file-naming-conventions">File Naming Conventions</a></li> <li><a href="./create-and-edit#edit-a-document">Edit a Document</a></li> <li><a href="./create-and-edit#create-a-document">Create a Document</a></li> <li><a href="./create-and-edit#addingreplacing-images">Adding/Replacing Images</a></li> <li><a href="./create-and-edit#alt-text-for-images">Alt Text for Images</a></li> <li><a href="./create-and-edit#embedding-videos">Embedding Videos</a></li> <li><a href="./create-and-edit#creating-assets-folder">Creating Assets Folder</a></li> <li><a href="./create-and-edit#creating-a-pull-request">Creating a Pull Request</a></li> <li><a href="./create-and-edit#save-and-continue-edits-to-branch">Save and Continue Edits to Branch</a></li> </ul> </li> <li><a href="./style-and-format">Style and Format</a> <ul> <li><a href="./style-and-format#versioning-and-updates">Versioning and Updates</a></li> <li><a href="./style-and-format#images">Images</a></li> <li><a href="./style-and-format#spelling">Spelling</a></li> <li><a href="./style-and-format#pronouns">Pronouns</a></li> <li><a href="./style-and-format#accessible-hyperlinks">Accessible Hyperlinks</a></li> <li><a href="./style-and-format#order-of-headings">Order of Headings</a></li> <li><a href="./style-and-format#blockquote-styles">Blockquote Styles</a></li> <li><a href="./style-and-format#linking-to-external-files">External Files</a></li> <li><a href="./style-and-format#attribution">Attribution</a></li> <li><a href="./style-and-format#tips-for-writing-documentation">Tips for Writing Documentation</a></li> <li><a href="./style-and-format#tips-for-video-documentation">Tips for Video Documentation</a></li> </ul> </li> <li><a href="./copyright">Copyright and Licensing</a></li> </ul> </div> <div class="book__backToHub"> <span class="fa fa-long-arrow-alt-left" aria-hidden="true"></span> <p>Back to <a href="/">all documentation</a>.</p> </div> <div class="book__spacer"></div> </div> </div> <div class="book__footerWrapper"> <div class="siteFooter"> <nav class="siteFooter__container"> <div class="siteFooter__top"> <div class="siteFooter__nav"> <div class="siteFooter__navHeader"> Contact Us </div> <p>Have a question or suggestion about PKP鈥檚 documentation and user guides? <a href="https://pkp.sfu.ca/documentation-feedback/">Use our documentation contact form</a>.</p> <p>If your message is not about documentation, please use the general <a href="https://pkp.sfu.ca/contact-us/">contact form</a>.</p> </div> <div class="siteFooter__nav"> <div class="siteFooter__navHeader"> Community </div> <p><a href="https://pkp.sfu.ca/documentation-interest-group/">Documentation Interest Group</a></p> <p><a href="/contributing/en/">Contributing Documentation</a></p> <p><a href="/translating-guide/">Translating Guide</a></p> <p><a href="https://forum.pkp.sfu.ca">Community Forum</a></p> </div> <div class="siteFooter__nav"> <div class="siteFooter__navHeader"> About </div> <p><a href="https://pkp.sfu.ca">Public Knowledge Project</a></p> <p><a href="https://pkpservices.sfu.ca/">PKP|Publishing Services</a></p> </div> <div class="siteFooter__logo"> <a href="https://pkp.sfu.ca"> <img src="/img/logo-on-grey.png" alt="Public Knowledge Project"> </a> <p>The Public Knowledge Project is a Core Facility of Simon Fraser University</p> <p>888 University Drive, Burnaby, B.C., Canada V5A 1S6</p> <p>We respectfully acknowledge that SFU occupies the unceded traditional territories of the Coast Salish peoples of the Musqueam, Squamish, and Tsleil-Waututh Nations.</p> </div> </div> <div class="siteFooter__bottom"> <p class="footer-copyright"><span class="terms-text"><a href="https://www.sfu.ca/contact/terms-conditions.html" target="_blank">TERMS & CONDITIONS</a> © SIMON FRASER UNIVERSITY.</span><span class="copyright-text"><img src="/img/creativecommons.svg" alt="Creative Commons logo" /><img src="/img/attribution.svg" alt="Attribution icon" /><a href="https://creativecommons.org/licenses/by/2.0/" target="_blank">CC-BY 2.0</a></span><span class="footer-copyright-separator"> | </span><span class="ab-link">Website by <a target="_blank" href="https://www.affinitybridge.com">Affinity Bridge</a></span></p> </div> </div> </div> </div> <script type="text/javascript">/** * Toggle the sidebar open/closed */ (function() { var sidebar = document.getElementById('sidebar'); var sidebarControl = document.getElementById('sidebarControl'); var isOpen = false; var sidebarOpenClass = ' -sidebarIsOpen'; if (!sidebar || !sidebarControl) { return; } // Toggle sidebar function toggle() { if (isOpen) { document.body.className = document.body.className.replace(new RegExp(sidebarOpenClass, 'g'), ''); } else { document.body.className = document.body.className + sidebarOpenClass; } isOpen = !isOpen; } sidebarControl.addEventListener('click', toggle); })(); </script> <script type="text/javascript">/** * Initialize smooth scrolling to anchor links * * See: https://github.com/cferdinandi/smooth-scroll */ (function() { function init() { if (typeof SmoothScroll === 'undefined') { setTimeout(init, 500); } else { var scroll = new SmoothScroll('a[href*="#"]', {easing: 'easeInOutCubic', offset:80}); } } init(); })(); </script>  <script async src="https://www.googletagmanager.com/gtag/js?id=UA-130558797-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-130558797-1'); </script>  <script> (function(h,o,t,j,a,r){ h.hj=h.hj||function(){(h.hj.q=h.hj.q||[]).push(arguments)}; h._hjSettings={hjid:2436159,hjsv:6}; a=o.getElementsByTagName('head')[0]; r=o.createElement('script');r.async=1; r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv; a.appendChild(r); })(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv='); </script>  <script type="text/javascript"> var _paq = _paq || []; _paq.push(["setDocumentTitle", document.domain + "/" + document.title]); _paq.push(["setCookieDomain", "*.docs.pkp.sfu.ca"]); _paq.push(["setDomains", ["*.docs.pkp.sfu.ca"]]); _paq.push(["trackPageView"]); _paq.push(["enableLinkTracking"]); (function() { var u = (("https:" == document.location.protocol) ? "https" : "http") + "://" + "matomo.publicknowledgeproject.org/pkp/"; _paq.push(["setTrackerUrl", u + "piwik.php"]); _paq.push(["setSiteId", "40"]); var d = document, g = d.createElement("script"), s = d.getElementsByTagName("script")[0]; g.type = "text/javascript"; g.defer = true; g.async = true; g.src = u + "piwik.js"; s.parentNode.insertBefore(g, s); })(); </script>  </body> </html>

CINXE.COM

Contribute - Guidelines for Contributing to PKP Documentation