From 01c263df2dae6b67ad35eb853389b575282222cd Mon Sep 17 00:00:00 2001 From: Nathan Bogale Date: Tue, 14 Jan 2025 16:48:20 +0300 Subject: [PATCH 1/4] fix: schema updates, opensource and definitions --- ...38-9258-4fbc-a62e-7faa6e58318f.schema.json | 37 +-- .../F14-Generic/example.proposal.json | 267 +++++++++--------- 2 files changed, 153 insertions(+), 151 deletions(-) diff --git a/docs/src/architecture/08_concepts/document_templates/proposal/F14-Generic/0ce8ab38-9258-4fbc-a62e-7faa6e58318f.schema.json b/docs/src/architecture/08_concepts/document_templates/proposal/F14-Generic/0ce8ab38-9258-4fbc-a62e-7faa6e58318f.schema.json index a66ce3133ce..002f3325e0e 100644 --- a/docs/src/architecture/08_concepts/document_templates/proposal/F14-Generic/0ce8ab38-9258-4fbc-a62e-7faa6e58318f.schema.json +++ b/docs/src/architecture/08_concepts/document_templates/proposal/F14-Generic/0ce8ab38-9258-4fbc-a62e-7faa6e58318f.schema.json @@ -3,6 +3,12 @@ "$id": "https://cardano.org/schemas/catalyst/f14/proposal", "title": "F14 Submission Form", "description": "Schema for the F14 Catalyst Proposal Submission Form", + "version": "1.0.0", + "lastUpdated": "2025-01-14", + "maintainers": ["Cardano Foundation"], + "changelog": { + "1.0.0": "Initial version" + }, "definitions": { "schemaReferenceNonUI": { "$comment": "NOT UI: used to identify the kind of template document used.", @@ -33,8 +39,8 @@ "$comment": "UI - Single Line text entry for HTTPS Urls.", "type": "string", "format": "uri", - "pattern": "^https:.*", - "x-note": "Enter a valid HTTPS URL. Must start with 'https://' and be a complete, working web address." + "pattern": "^[^\\n\\r]*$", + "x-note": "Must start with 'https://' and is followed by one or more non-whitespace characters, ending at the end of the string." }, "multiLineTextEntry": { "$comment": "UI - Multiline text entry without any markup or rich text capability.", @@ -498,28 +504,25 @@ "description": "Will your project's output be fully open source? Open source refers to something people can modify and share because its design is publicly accessible.", "x-guidance": "Open source software is software with source code that anyone can inspect, modify, and enhance. Conversely, only the original authors of proprietary software can legally copy, inspect, and alter that software", "properties": { - "source_code": { - "$ref": "#/definitions/spdxLicenseOrURL" - }, - "documentation": { - "$ref": "#/definitions/spdxLicenseOrURL" + "isOpenSource": { + "$ref": "#/definitions/yesNoChoice", + "title": "Is the project open source?", + "description": "Select Yes if the project is open source, No if it is not." }, - "note": { + "licenseInformation": { "$ref": "#/definitions/multiLineTextEntry", - "title": "More Information", - "description": "Please provide here more information on the open source status of your project outputs", - "maxLength": 500, - "x-guidance": "

If you did not answer PROPRIETARY to the above questions, the project should be open source available throughout the entire lifecycle of the project with a declared open-source repository. Please indicate here the type of license you intend to use for open source and provide any further information you feel is relevant to the open source status of your project outputs If only certain elements of your code will be open source please clarify which elements will be open source here. If you answered NO to the above question, please give further details as to why your projects outputs will not be open source METADATA

" + "title": "License and Additional Information", + "description": "Provide the license type and any additional context regarding the open-source status of your project. If partially open source, specify which parts are open source.", + "maxLength": 500 } }, "required": [ - "source_code", - "documentation" + "isOpenSource", + "licenseInformation" ], "x-order": [ - "source_code", - "documentation", - "note" + "isOpenSource", + "licenseInformation" ] } }, diff --git a/docs/src/architecture/08_concepts/document_templates/proposal/F14-Generic/example.proposal.json b/docs/src/architecture/08_concepts/document_templates/proposal/F14-Generic/example.proposal.json index 93918bc53ef..db0bfc66896 100644 --- a/docs/src/architecture/08_concepts/document_templates/proposal/F14-Generic/example.proposal.json +++ b/docs/src/architecture/08_concepts/document_templates/proposal/F14-Generic/example.proposal.json @@ -1,135 +1,134 @@ -{ - "$schema": "./0ce8ab38-9258-4fbc-a62e-7faa6e58318f.schema.json", - "setup": { - "title": { - "title": "Example Catalyst Proposal" - }, - "proposer": { - "applicant": "John Smith", - "type": "Individual", - "coproposers": [ - "Jane Doe", - "Bob Wilson" - ] - } - }, - "summary": { - "budget": { - "requestedFunds": 150000 - }, - "time": { - "duration": 6 - }, - "translation": { - "isTranslated": true, - "originalLanguage": "de", - "originalDocumentLink": "https://example.com/original-doc" - }, - "problem": { - "statement": "Current challenge in the Cardano ecosystem...", - "impact": [ - "Technical Infrastructure", - "Developer Tooling", - "Adoption" - ] - }, - "solution": { - "summary": "Our solution provides a comprehensive toolkit...", - "approach": "We will implement this solution using...", - "innovationAspects": [ - "Novel testing framework", - "Automated integration tools" - ] - }, - "supportingLinks": { - "mainRepository": "https://github.com/example/project", - "documentation": "https://docs.example.com", - "other": [ - "https://example.com/whitepaper", - "https://example.com/roadmap" - ] - }, - "dependencies": { - "details": [{ - "name": "External API Service", - "type": "Technical", - "description": "Integration with third-party API service", - "mitigationPlan": "Build fallback mechanisms and maintain alternative providers" - }] - }, - "open_source": { - "source_code": "MIT", - "documentation": "MIT", - "note": "All project outputs will be open source under MIT license" - } - }, - "horizons": { - "theme": { - "grouped_tag": { - "group": "DeFi", - "tag": "Staking" - } - } - }, - "details": { - "solution": { - "solution": "Our solution involves developing a comprehensive toolkit that will enhance the Cardano developer experience..." - }, - "impact": { - "impact": "The project will significantly impact developer productivity by reducing development time and improving code quality..." - }, - "feasibility": { - "feasibility": "Our team has extensive experience in blockchain development and has successfully delivered similar projects..." - } - }, - "milestones": { - "milestones": { - "milestone_list": [{ - "title": "Initial Setup and Planning", - "outputs": "Project infrastructure setup and detailed planning documents", - "acceptance_criteria": "- Development environment configured\n- Detailed project plan approved", - "evidence": "- GitHub repository setup\n- Documentation of infrastructure\n- Project planning documents", - "delivery_month": 1, - "cost": 30000, - "progress": "Not Started" - }, - { - "title": "Core Development", - "outputs": "Implementation of main features", - "acceptance_criteria": "- Core features implemented\n- Unit tests passing", - "evidence": "- Code repository\n- Test results\n- Technical documentation", - "delivery_month": 3, - "cost": 60000, - "progress": "Not Started" - }, - { - "title": "Final Release and Documentation", - "outputs": "Project completion, documentation, and Project Close-out Report and Video", - "acceptance_criteria": "- All features implemented and tested\n- Documentation complete\n- Close-out report and video delivered", - "evidence": "- Final release\n- Complete documentation\n- Close-out report and video", - "delivery_month": 6, - "cost": 60000, - "progress": "Not Started" - } - ] - } - }, - "pitch": { - "team": { - "who": "Our team consists of experienced blockchain developers with proven track records..." - }, - "budget": { - "costs": "Budget breakdown:\n- Development (70%): 105,000 ADA\n- Testing (15%): 22,500 ADA\n- Documentation (15%): 22,500 ADA" - }, - "value": { - "note": "This project provides excellent value for money by delivering essential developer tools..." - } - }, - "agreements": { - "mandatory": { - "fund_rules": true, - "terms_and_conditions": true, - "privacy_policy": true - } - } +{ + "$schema": "./0ce8ab38-9258-4fbc-a62e-7faa6e58318f.schema.json", + "setup": { + "title": { + "title": "Example Catalyst Proposal" + }, + "proposer": { + "applicant": "John Smith", + "type": "Individual", + "coproposers": [ + "Jane Doe", + "Bob Wilson" + ] + } + }, + "summary": { + "budget": { + "requestedFunds": 150000 + }, + "time": { + "duration": 6 + }, + "translation": { + "isTranslated": true, + "originalLanguage": "de", + "originalDocumentLink": "https://example.com/original-doc" + }, + "problem": { + "statement": "Current challenge in the Cardano ecosystem...", + "impact": [ + "Technical Infrastructure", + "Developer Tooling", + "Adoption" + ] + }, + "solution": { + "summary": "Our solution provides a comprehensive toolkit...", + "approach": "We will implement this solution using...", + "innovationAspects": [ + "Novel testing framework", + "Automated integration tools" + ] + }, + "supportingLinks": { + "mainRepository": "https://github.com/example/project", + "documentation": "https://docs.example.com", + "other": [ + "https://example.com/whitepaper", + "https://example.com/roadmap" + ] + }, + "dependencies": { + "details": [{ + "name": "External API Service", + "type": "Technical", + "description": "Integration with third-party API service", + "mitigationPlan": "Build fallback mechanisms and maintain alternative providers" + }] + }, + "open_source": { + "isOpenSource": true, + "licenseInformation": "All source code and documentation will be released under the MIT license." + } + }, + "horizons": { + "theme": { + "grouped_tag": { + "group": "DeFi", + "tag": "Staking" + } + } + }, + "details": { + "solution": { + "solution": "Our solution involves developing a comprehensive toolkit that will enhance the Cardano developer experience..." + }, + "impact": { + "impact": "The project will significantly impact developer productivity by reducing development time and improving code quality..." + }, + "feasibility": { + "feasibility": "Our team has extensive experience in blockchain development and has successfully delivered similar projects..." + } + }, + "milestones": { + "milestones": { + "milestone_list": [{ + "title": "Initial Setup and Planning", + "outputs": "Project infrastructure setup and detailed planning documents", + "acceptance_criteria": "- Development environment configured\n- Detailed project plan approved", + "evidence": "- GitHub repository setup\n- Documentation of infrastructure\n- Project planning documents", + "delivery_month": 1, + "cost": 30000, + "progress": "Not Started" + }, + { + "title": "Core Development", + "outputs": "Implementation of main features", + "acceptance_criteria": "- Core features implemented\n- Unit tests passing", + "evidence": "- Code repository\n- Test results\n- Technical documentation", + "delivery_month": 3, + "cost": 60000, + "progress": "Not Started" + }, + { + "title": "Final Release and Documentation", + "outputs": "Project completion, documentation, and Project Close-out Report and Video", + "acceptance_criteria": "- All features implemented and tested\n- Documentation complete\n- Close-out report and video delivered", + "evidence": "- Final release\n- Complete documentation\n- Close-out report and video", + "delivery_month": 6, + "cost": 60000, + "progress": "Not Started" + } + ] + } + }, + "pitch": { + "team": { + "who": "Our team consists of experienced blockchain developers with proven track records..." + }, + "budget": { + "costs": "Budget breakdown:\n- Development (70%): 105,000 ADA\n- Testing (15%): 22,500 ADA\n- Documentation (15%): 22,500 ADA" + }, + "value": { + "note": "This project provides excellent value for money by delivering essential developer tools..." + } + }, + "agreements": { + "mandatory": { + "fund_rules": true, + "terms_and_conditions": true, + "privacy_policy": true + } + } } \ No newline at end of file From 2728bea09702ec4e36f8f30ffa412c0cc4f2df5f Mon Sep 17 00:00:00 2001 From: Nathan Bogale Date: Wed, 15 Jan 2025 20:27:52 +0300 Subject: [PATCH 2/4] fix: changelog on proposal template, and other optional fixes --- ...0ce8ab38-9258-4fbc-a62e-7faa6e58318f.schema.json | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/src/architecture/08_concepts/document_templates/proposal/F14-Generic/0ce8ab38-9258-4fbc-a62e-7faa6e58318f.schema.json b/docs/src/architecture/08_concepts/document_templates/proposal/F14-Generic/0ce8ab38-9258-4fbc-a62e-7faa6e58318f.schema.json index 002f3325e0e..92b826868fe 100644 --- a/docs/src/architecture/08_concepts/document_templates/proposal/F14-Generic/0ce8ab38-9258-4fbc-a62e-7faa6e58318f.schema.json +++ b/docs/src/architecture/08_concepts/document_templates/proposal/F14-Generic/0ce8ab38-9258-4fbc-a62e-7faa6e58318f.schema.json @@ -3,11 +3,14 @@ "$id": "https://cardano.org/schemas/catalyst/f14/proposal", "title": "F14 Submission Form", "description": "Schema for the F14 Catalyst Proposal Submission Form", - "version": "1.0.0", - "lastUpdated": "2025-01-14", - "maintainers": ["Cardano Foundation"], - "changelog": { - "1.0.0": "Initial version" + "maintainers": [{ "name": "Catalyst Team", "url": "https://cardano.org" }], + "x-changelog": { + "2025-01-14": + [ + "Updated schema to include new fields for proposal details.", + "Fixed validation issues with the URL pattern.", + "Improved documentation for open source requirements." + ] }, "definitions": { "schemaReferenceNonUI": { From c7ba331049f0fe35a80bcea29e2c227ddabd6122 Mon Sep 17 00:00:00 2001 From: Nathan Bogale Date: Thu, 16 Jan 2025 20:30:48 +0300 Subject: [PATCH 3/4] Update docs/src/architecture/08_concepts/document_templates/proposal/F14-Generic/0ce8ab38-9258-4fbc-a62e-7faa6e58318f.schema.json Co-authored-by: Steven Johnson --- .../0ce8ab38-9258-4fbc-a62e-7faa6e58318f.schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/architecture/08_concepts/document_templates/proposal/F14-Generic/0ce8ab38-9258-4fbc-a62e-7faa6e58318f.schema.json b/docs/src/architecture/08_concepts/document_templates/proposal/F14-Generic/0ce8ab38-9258-4fbc-a62e-7faa6e58318f.schema.json index 92b826868fe..6072d3b5c72 100644 --- a/docs/src/architecture/08_concepts/document_templates/proposal/F14-Generic/0ce8ab38-9258-4fbc-a62e-7faa6e58318f.schema.json +++ b/docs/src/architecture/08_concepts/document_templates/proposal/F14-Generic/0ce8ab38-9258-4fbc-a62e-7faa6e58318f.schema.json @@ -3,7 +3,7 @@ "$id": "https://cardano.org/schemas/catalyst/f14/proposal", "title": "F14 Submission Form", "description": "Schema for the F14 Catalyst Proposal Submission Form", - "maintainers": [{ "name": "Catalyst Team", "url": "https://cardano.org" }], + "maintainers": [{ "name": "Catalyst Team", "url": "https://projectcatalyst.io/" }], "x-changelog": { "2025-01-14": [ From b401a2a56f777f9d3eb45b3d713f4a48db3001b9 Mon Sep 17 00:00:00 2001 From: Nathan Bogale Date: Thu, 16 Jan 2025 20:39:12 +0300 Subject: [PATCH 4/4] fix: enforced https --- .../0ce8ab38-9258-4fbc-a62e-7faa6e58318f.schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/architecture/08_concepts/document_templates/proposal/F14-Generic/0ce8ab38-9258-4fbc-a62e-7faa6e58318f.schema.json b/docs/src/architecture/08_concepts/document_templates/proposal/F14-Generic/0ce8ab38-9258-4fbc-a62e-7faa6e58318f.schema.json index 6072d3b5c72..82acb8c6b83 100644 --- a/docs/src/architecture/08_concepts/document_templates/proposal/F14-Generic/0ce8ab38-9258-4fbc-a62e-7faa6e58318f.schema.json +++ b/docs/src/architecture/08_concepts/document_templates/proposal/F14-Generic/0ce8ab38-9258-4fbc-a62e-7faa6e58318f.schema.json @@ -42,7 +42,7 @@ "$comment": "UI - Single Line text entry for HTTPS Urls.", "type": "string", "format": "uri", - "pattern": "^[^\\n\\r]*$", + "pattern": "^https://[^\\s]+$", "x-note": "Must start with 'https://' and is followed by one or more non-whitespace characters, ending at the end of the string." }, "multiLineTextEntry": {