Proposal: Dev Portal Documentation (Q1 2020)

<h3>Synopsis <p dir="auto">I will continue to provide documentation intended for application and tool developers who work on the Steem blockchain. <h3>Timeframe <p dir="auto">First Quarter, 2020. Total pay requested for timeframe: <code>44569 SBD <p dir="auto">Unlike my previous proposals, I am now assuming that the work is 100% full time. I have other sources of income that take priority if this proposal is not approved. I think it's just easier for me to keep them equal in priority. <hr /> <h6>As I have <a href="https://steempeak.com/steemdao/@inertia/proposal-39-funding-on-pause" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">stated previously, I intend to work on the devportal as a hobby if my proposal is not funded, but this would mean applying a far lower priority. <hr /> <p dir="auto">Also in my previous proposals, I intentionally under-bided in order to seek approval. I'm not doing that this time either. This proposal is at my full rate. I believe a side-effect of this is to set the price of this kind of work for people who have a lower costs. If you can do as good a job as me for less pay, you should totally do it, with my blessing (just <a href="https://github.com/steemit/devportal" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">fork the repo and get cracking). <p dir="auto">If I am funded, but unable to allocate full time away from my main sources of income, I will return the proposal pay. I'll evaluate this throughout the proposal timeframe, probably weekly. <p dir="auto">For the amount I'm asking for, I also intend to sub-contract <em>certain aspects of devportal work, when appropriate, i.e.: no sub-contracting that has to do with the reverse-engineering or investigation on Steem technology itself. I am not sub-contracting the documentation. <p dir="auto">Instead, sub-contracts may include UI/UX design, QA, and usability testing. UI/UX work will likely be minimal. I think it's pretty usable already. QA is for obvious navigation and multi-browser verification. The "testing" sub-contracting will be the most useful because I want to make sure the tutorials and definitions I provide can be understood by developers who are <em>not already familiar with Steem. <p dir="auto">I am also assuming 1 SBD is approximately $1. This is because if I have faith in my work (and the rest of the platform), it should be reflected in my proposal. If I think I can bring value to the platform, it should indirectly contribute to improving the price of STEEM, which should indirectly strengthen the peg. Therefore, I have an incentive to do good work in order to strengthen the peg. <h3>Background <p dir="auto">The devportal site was originally set up by Steemit, Inc. two years ago and announced <a href="https://steemit.com/steemdev/@steemitdev/announcing-the-steem-developer-portal" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">here. It is backed by <a href="https://jekyllrb.com/" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">jekyll, which is a perfect fit for me because the framework is written in ruby. However, the documentation itself does not require an understanding of ruby, as it is expressed in a combination of Markdown and Yaml. <p dir="auto">This means it's relatively easy to contribute new documentation, whichever programming language you're familiar with. But for me, it allows me to expand the framework. For example, I have <a href="https://github.com/steemit/devportal/pull/412" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">expanded the devportal so that it can fetch blockchain posts and host them just like any other content. I have also expanded the documentation build tools <a href="https://github.com/steemit/devportal#rake-tasks" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">in other ways to verify content and make it easier to research new blockchain features. <p dir="auto">While it's relatively easy to contribute new documentation, the research itself is a bit more involved (see: <strong>Qualifications section). <h3>Deliverables <p dir="auto"><a href="https://github.com/inertia186/devportal/projects?query=is%3Aclosed" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">archives)<span>For the duration of the proposal work Q1 timeframe, my ongoing project plan is here: <a href="https://github.com/inertia186/devportal/projects" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://github.com/inertia186/devportal/projects (also see: <p dir="auto">Current plan summary: <ol> <li>Top priority is updating and clarifying the API Definitions (<a href="https://developers.steem.io/apidefinitions/" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">example). This will help developers who want to query/broadcast objects. It has all of the structure and examples needed to interact with the blockchain. <ol> <li>Requires me to interpret the source code, tests, and whitepapers then translate them to uniform definitions. <li>Which in turn allows tool developers to create new tools/features as they appear. <li>Maintaining an index of up-to-date tools (<a href="https://developers.steem.io/resources/#resources-steem-connect-libs" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">example). <li>Structural changes to improve navigation, including search improvements. <li>Updated glossary of terms pertinent to developer understanding of the technology (<a href="https://developers.steem.io/glossary/" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">example). <ol> <li>Also add a reverse lookup to the glossary. <li>Allows a developer to dig into a particular topic from the top down. <li>Additional tutorials on new features and concepts. <li>Additional tutorials on deploying different kinds of nodes. <ol> <li>For example, a "signing server" node. <li>Ongoing fixes and updates to various details. <ol> <li>Testnet specifics. <li><span>Public node directory (although <a href="/@timcliff">@timcliff keeps an eye on this as well). <h3>Qualifications <p dir="auto">I was on the Steemit, Inc. payroll for 10 months. During that time, I learned the development philosophy and culture and I was part of a developer group called SteemWorks. <p dir="auto">I am also accomplished at reverse-engineering, which is a requirement for doing heavy documentation on the Steem blockchain. <p dir="auto">I have also had two previous proposals approved for this kind of work. <h3>Previous Work <p dir="auto">Here are all of the changes during my previous two proposals: <ol> <li>Added SPS to API Definitions (<a href="https://github.com/steemit/devportal/pull/420" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">PR#420). <ol> <li><span><a href="https://developers.steem.io/apidefinitions/#broadcast_ops_proposal_pay" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/apidefinitions/#broadcast_ops_proposal_pay <li><span><a href="https://developers.steem.io/apidefinitions/#database_api.find_proposals" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/apidefinitions/#database_api.find_proposals <li>Added details to the glossary (<a href="https://github.com/steemit/devportal/pull/421" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">PR#421). <ol> <li><span><a href="https://developers.steem.io/glossary/" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/glossary/ <li>Various API Definitions fixes (<a href="https://github.com/steemit/devportal/pull/422" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">PR#422). <ol> <li><span><a href="https://developers.steem.io/apidefinitions/#rc_api.get_resource_params" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/apidefinitions/#rc_api.get_resource_params <li><span><a href="https://developers.steem.io/apidefinitions/#reputation_api.get_account_reputations" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/apidefinitions/#reputation_api.get_account_reputations <li>Various Plug-in and API fixes (<a href="https://github.com/steemit/devportal/pull/423" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">PR#423). <ol> <li><span><a href="https://developers.steem.io/apidefinitions/#rewards_api.simulate_curve_payouts" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/apidefinitions/#rewards_api.simulate_curve_payouts <li><span><a href="https://developers.steem.io/tutorials-recipes/plugin-and-api-list#rewards_api" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/tutorials-recipes/plugin-and-api-list#rewards_api <li>Setting Up a Testnet (<a href="https://github.com/steemit/devportal/pull/424" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">PR#424). <ol> <li><span><a href="https://developers.steem.io/tutorials-recipes/setting-up-a-testnet" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/tutorials-recipes/setting-up-a-testnet <li>Paginated API methods (<a href="https://github.com/steemit/devportal/pull/425" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">PR#425). <ol> <li><span><a href="https://developers.steem.io/tutorials-recipes/paginated-api-methods" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/tutorials-recipes/paginated-api-methods <li>Added basic Steem Keychain information (<a href="https://github.com/steemit/devportal/pull/426" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">PR#426). <ol> <li><span><a href="https://developers.steem.io/resources/#resources-steem-keychain" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/resources/#resources-steem-keychain <li>Added Steem.DAO to Services section (<a href="https://github.com/steemit/devportal/pull/427" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">PR#427). <ol> <li><span><a href="https://developers.steem.io/services/#services-steem-dao" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/services/#services-steem-dao <li>Created steemd <code>config.ini recipe (<a href="https://github.com/steemit/devportal/pull/428" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">PR#428). <ol> <li><span><a href="https://developers.steem.io/tutorials-recipes/node-config" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/tutorials-recipes/node-config <li>Created steemd command-line options recipe (<a href="https://github.com/steemit/devportal/pull/429" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">PR#429). <ol> <li><span><a href="https://developers.steem.io/tutorials-recipes/node-cli" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/tutorials-recipes/node-cli <li>Fix to <code>canonical_url header (<a href="https://github.com/steemit/devportal/pull/430" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">PR#430). <ol> <li><span><a href="https://developers.steem.io/tutorials-recipes/using-multisignatire-accounts" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/tutorials-recipes/using-multisignatire-accounts <li>Linking back to Pagination recipe from API Definitions (<a href="https://github.com/steemit/devportal/pull/431" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">PR#431). <ol> <li><span><a href="https://developers.steem.io/apidefinitions/#database_api.list_accounts" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/apidefinitions/#database_api.list_accounts (just one of many examples) <li>SMT API Definitions (<a href="https://github.com/steemit/devportal/pull/432" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">PR#432). <ol> <li><span><a href="https://developers.steem.io/apidefinitions/#database_api.find_smt_contributions" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/apidefinitions/#database_api.find_smt_contributions <li><span><a href="https://developers.steem.io/apidefinitions/#broadcast_ops_claim_reward_balance2" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/apidefinitions/#broadcast_ops_claim_reward_balance2 <li>Include pre-existing content about mira performance tuning (<a href="https://github.com/steemit/devportal/pull/433" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">PR#433). <ol> <li><span><a href="https://developers.steem.io/tutorials-recipes/mira-performance-tuning" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/tutorials-recipes/mira-performance-tuning <li>Search fix (<a href="https://github.com/steemit/devportal/pull/434" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">PR#434). <ol> <li><span><a href="https://developers.steem.io/search/" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/search/ <li>Merge broadcast ops into one page (<a href="https://github.com/steemit/devportal/pull/435" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">PR#435). <ol> <li><span><a href="https://developers.steem.io/apidefinitions/#apidefinitions-broadcast-ops" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/apidefinitions/#apidefinitions-broadcast-ops <li>Node setup that supports <code>*.get_transaction (<a href="https://github.com/steemit/devportal/pull/436" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">PR#436). <li>Updated tutorial/quickstart (<a href="https://github.com/steemit/devportal/pull/437" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">PR#437). <ol> <li><span><a href="https://developers.steem.io/quickstart/#quickstart-testnet" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/quickstart/#quickstart-testnet <li><span><a href="https://developers.steem.io/tutorials-recipes/setting-up-a-testnet" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/tutorials-recipes/setting-up-a-testnet <li>Added method/op names to the top of each section (<a href="https://github.com/steemit/devportal/pull/438" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">PR#438). <ol> <li><span><a href="https://developers.steem.io/apidefinitions/" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/apidefinitions/ (all sections) <li>Improved Search Hits (<a href="https://github.com/steemit/devportal/pull/439" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">PR#439). <ol> <li><span><a href="https://developers.steem.io/search/" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/search/ <li>Exchange Node Setup (<a href="https://github.com/steemit/devportal/pull/440" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">PR#440). <ol> <li><span><a href="https://developers.steem.io/tutorials-recipes/exchange_node" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/tutorials-recipes/exchange_node <li>Abstracted DGPO/config (also improves search) (<a href="https://github.com/steemit/devportal/pull/441" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">PR#441). <ol> <li><span><a href="https://developers.steem.io/tutorials-recipes/understanding-dynamic-global-properties" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/tutorials-recipes/understanding-dynamic-global-properties <li><span><a href="https://developers.steem.io/tutorials-recipes/understanding-configuration-values" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/tutorials-recipes/understanding-configuration-values <li><span><a href="https://developers.steem.io/search/" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/search/ <li>Marked <code>clear_null_account_balance as deprecated (<a href="https://github.com/steemit/devportal/pull/442" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">PR#442). <ol> <li><span><a href="https://developers.steem.io/apidefinitions/#broadcast_ops_clear_null_account_balance" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/apidefinitions/#broadcast_ops_clear_null_account_balance <li>New testnet chain-id (<a href="https://github.com/steemit/devportal/pull/443" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">PR#443). <ol> <li><span><a href="https://developers.steem.io/quickstart/#quickstart-testnet" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/quickstart/#quickstart-testnet <li><span><a href="https://developers.steem.io/tutorials-recipes/setting-up-a-testnet" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/tutorials-recipes/setting-up-a-testnet <li>Added steem-tx-js client library (<a href="https://github.com/steemit/devportal/pull/444" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">PR#444). <ol> <li><span><a href="https://developers.steem.io/resources/#resources-steem-connect-libs" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://developers.steem.io/resources/#resources-steem-connect-libs <li>Improved glossary search (<a href="https://github.com/steemit/devportal/pull/446" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">PR#446). <li>Added Communities API Definitions (<a href="https://github.com/steemit/devportal/pull/447" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">PR#447). <h3>Proposal Approval/Rejection Criteria <p dir="auto">You should approve this proposal if you would like me to be compensated through SPS Inflation. <p dir="auto">You should reject this proposal if you would prefer that I apply a lower priority on these tasks. <p dir="auto">To approve, please find the link below. If you have already approved, but have subsequently changed your mind, there is also an option to remove your approval. <p dir="auto">To reject, just ignore this proposal. <h3>Proposal Record <p dir="auto"><a href="https://beta.steemconnect.com/sign/update-proposal-votes?proposal_ids=[63]&approve=true" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">Approve<br /> <a href="https://beta.steemconnect.com/sign/update-proposal-votes?proposal_ids=[63]&approve=false" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">Unapprove <hr /> <p dir="auto">Also see: <ul> <li><span><a href="https://steemproposals.com/proposals/inertia" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://steemproposals.com/proposals/inertia <li><span><a href="https://steempeak.com/proposals" target="_blank" rel="noreferrer noopener" title="This link will take you away from hive.blog" class="external_link">https://steempeak.com/proposals