From 797c04262926652116af4a256f462b5bee461191 Mon Sep 17 00:00:00 2001 From: Daniel Ternyak Date: Tue, 10 Dec 2019 15:32:12 -0600 Subject: [PATCH] Fix typos / copy (#109) Update default proposal content Create Guide section --- backend/grant/proposal/models.py | 32 +++++++++++++------ frontend/client/Routes.tsx | 13 ++++++++ frontend/client/components/CCRFlow/Basics.tsx | 2 +- .../client/components/CreateFlow/Basics.tsx | 2 +- .../components/CreateFlow/Milestones.tsx | 2 +- frontend/client/components/Header/index.tsx | 3 ++ .../client/components/Proposals/index.tsx | 2 +- frontend/client/pages/guide.tsx | 7 ++++ frontend/client/static/markdown/GUIDE.md | 1 + 9 files changed, 51 insertions(+), 13 deletions(-) create mode 100644 frontend/client/pages/guide.tsx create mode 100644 frontend/client/static/markdown/GUIDE.md diff --git a/backend/grant/proposal/models.py b/backend/grant/proposal/models.py index ed05567d..c008de18 100644 --- a/backend/grant/proposal/models.py +++ b/backend/grant/proposal/models.py @@ -229,24 +229,38 @@ class ProposalArbiter(db.Model): def default_proposal_content(): - return """# Overview + return """# Applicant background -Help us understand the goal(s) of the proposal at a high level. +Summarize you and/or your team’s background and experience. Demonstrate that you have the skills and expertise necessary for the project that you’re proposing. Institutional bona fides are not required, but we want to hear about your track record. +# Motivation and overview -# Approach +What are your high-level goals? Why are they important? How is your project connected to [ZF’s mission](https://www.zfnd.org/about/#mission) and priorities? Whose needs will it serve? -The plan for accomplishing the goal(s) laid out in the overview. +# Technical approach +Dive into the _how_ of your project. Describe your approaches, components, workflows, methodology, etc. Bullet points and diagrams are appreciated! -# Team +# Execution risks -Who you are, and why you're credible to execute on the goals of the proposal. +What obstacles do you expect? What is most likely to go wrong? Which unknown factors or dependencies could jeopardize success? What are your contingency plans? Will subsequent activities be required to maximize impact? +# Downsides + +What are the negative ramifications if your project is successful? Consider usability, stability, privacy, integrity, availability, decentralization, interoperability, maintainability, technical debt, requisite education, etc. + +# Evaluation plan + +What will your project look like if successful? How will we be able to tell? Include quantifiable metrics if possible. + +# Tasks and schedule + +What is your timeline for the project? Include concrete milestones and the major tasks required to complete each milestone. + +# Budget and justification + +How much funding do you need, and how will it be allocated (e.g., compensation for your effort, specific equipment, specific external services)? Specify a total cost, break it up into budget items, and explain the rationale for each. Feel free to present multiple options in terms of scope and cost. -# Deliverable - -The end result of your efforts as related to this proposal. """ diff --git a/frontend/client/Routes.tsx b/frontend/client/Routes.tsx index 385c8c92..0dda8225 100644 --- a/frontend/client/Routes.tsx +++ b/frontend/client/Routes.tsx @@ -25,6 +25,7 @@ const RequestEdit = loadable(() => import('pages/request-edit'), opts); const ProposalEdit = loadable(() => import('pages/proposal-edit'), opts); const Proposals = loadable(() => import('pages/proposals'), opts); const Proposal = loadable(() => import('pages/proposal'), opts); +const Guide = loadable(() => import('pages/guide'), opts); const Ccr = loadable(() => import('pages/ccr'), opts); const Auth = loadable(() => import('pages/auth')); const SignOut = loadable(() => import('pages/sign-out'), opts); @@ -205,6 +206,18 @@ const routeConfigs: RouteConfig[] = [ }, onlyLoggedIn: false, }, + { + // Terms of Service page + route: { + path: '/guide', + component: Guide, + exact: true, + }, + template: { + title: 'Guide', + }, + onlyLoggedIn: false, + }, { // About page route: { diff --git a/frontend/client/components/CCRFlow/Basics.tsx b/frontend/client/components/CCRFlow/Basics.tsx index 89173f4b..b9083d62 100644 --- a/frontend/client/components/CCRFlow/Basics.tsx +++ b/frontend/client/components/CCRFlow/Basics.tsx @@ -77,7 +77,7 @@ class CCRFlowBasics extends React.Component { validateStatus={errors.target ? 'error' : undefined} help={ errors.target || - 'Accepted proposals will be paid out in ZEC at market price at payout time. Zcash Foundation administrators may opt to adjust this value before approval.' + 'Accepted proposals will be paid out in ZEC based in USD market price at payout time. Zcash Foundation administrators may opt to adjust this value before approval.' } > { validateStatus={errors.target ? 'error' : undefined} help={ errors.target || - 'You will be paid out in ZEC at market price at payout time. This cannot be changed once your proposal starts' + 'You will be paid out in ZEC based in USD market price at payout time. This cannot be changed once your proposal starts' } > Payout Immediately - + diff --git a/frontend/client/components/Header/index.tsx b/frontend/client/components/Header/index.tsx index aa28e04b..122575c0 100644 --- a/frontend/client/components/Header/index.tsx +++ b/frontend/client/components/Header/index.tsx @@ -67,6 +67,9 @@ class Header extends React.Component { Requests + + Guide +
diff --git a/frontend/client/components/Proposals/index.tsx b/frontend/client/components/Proposals/index.tsx index 94d027ca..2d4963c9 100644 --- a/frontend/client/components/Proposals/index.tsx +++ b/frontend/client/components/Proposals/index.tsx @@ -113,7 +113,7 @@ class Proposals extends React.Component { The Zcash Foundation accepts proposals from community members to improve the Zcash ecosystem. Proposals are either funded by the Zcash Foundation directly, or are opened for community donations should they be approved - by the Zcash Foundation." + by the Zcash Foundation.

diff --git a/frontend/client/pages/guide.tsx b/frontend/client/pages/guide.tsx new file mode 100644 index 00000000..63d58a9b --- /dev/null +++ b/frontend/client/pages/guide.tsx @@ -0,0 +1,7 @@ +import React from 'react'; +import MarkdownPage from 'components/MarkdownPage'; +import GUIDE from 'static/markdown/GUIDE.md'; + +const Guide = () => ; + +export default Guide; diff --git a/frontend/client/static/markdown/GUIDE.md b/frontend/client/static/markdown/GUIDE.md new file mode 100644 index 00000000..b5aaad7d --- /dev/null +++ b/frontend/client/static/markdown/GUIDE.md @@ -0,0 +1 @@ +# Guide \ No newline at end of file