add project scope and release plan files

parent c0d91a57
= AsciiDoc Language
= AsciiDoc Language Project
This project maintains the AsciiDoc Language Specification, Technology Compatibility Kit (TCK), and end user documentation.
The AsciiDoc Language Specification describes the syntax, grammar, and APIs for the AsciiDoc language.
This project maintains the AsciiDoc Language Specification, Technology Compatibility Kit (TCK), end user documentation, and their related materials.
The AsciiDoc Language Specification describes the syntax and grammar, Abstract Semantic Graph (ASG), Document Object Model (DOM), referencing system, and APIs for processing, converting, and extending the language.
The TCK is used to verify and certify that an AsciiDoc processor implementation is compatible with this specification.
For further details, see the xref:process/scope.adoc[project's approved scope].
== Build the End User Documentation
......
= AsciiDoc Language Specification Release Plan
The https://projects.eclipse.org/proposals/asciidoc-language[project proposal] serves as the release plan for the first release of the AsciiDoc Language Specification.
The completion of the https://projects.eclipse.org/projects/technology.asciidoc/reviews/creation-review[creation review] and acceptance of the project by the Steering Committee kicked off the first release cycle of the specification.
This release cycle's <<goal,goal>> and <<schedule,project schedule>> were approved as part of the project proposal by the Steering Committee on July 27, 2020.
[#goal]
== Goal
The goal of the first, stable version of the specification is to match the AsciiDoc language as described by Asciidoctor 2.0.x as best as possible to minimize syntax and structure impacts on active AsciiDoc documents, but not propagate deprecations.
[#schedule]
== Project scheduling
In the project proposal, the scheduling was described as follows:
[quote]
The initial contributions are expected to be ready in Q2 2020.
Once the initial contributions are accepted and the project infrastructure and team process established, the plan is to iterate on the specification and TCK in coordination with projects that are working to provide a compatible implementation.
=== Initial contribution timeline [Done]
* [x] The Asciidoctor project prepared the end user documentation for AsciiDoc to serve as the initial contribution.
* [x] The initial contribution for the AsciiDoc Language was submitted to Eclipse for IP review on November 16, 2020.
* [x] The initial contribution received IP clearance on January 6, 2021.
* [x] The initial contribution was merged into the https://gitlab.eclipse.org/eclipse/asciidoc/asciidoc-lang[asciidoc-lang repository] on February 16, 2021.
== Release plan changes
The Steering Committee must be notified of any progress or release review date changes after a release plan is approved.
= AsciiDoc Language Project Scope
The AsciiDoc language project scope was approved as part of the https://projects.eclipse.org/proposals/asciidoc-language[project proposal] on July 27, 2020 by the AsciiDoc Working Group Steering Committee.
The AsciiDoc WG Steering Committee acts as the Specification Committee as stated in the https://www.eclipse.org/org/workinggroups/asciidoc-charter.php[working group's charter].
== Approved scope
The AsciiDoc language project defines and maintains the AsciiDoc Language Specification and Technology Compatibility Kit (TCK), its artifacts, and the corresponding language and API documentation.
The AsciiDoc Language Specification describes the syntax and grammar, Abstract Semantic Graph (ASG), Document Object Model (DOM), referencing system, and APIs for processing, converting, and extending the language.
The TCK is used to verify and certify that an AsciiDoc processor implementation is compatible with this specification.
Specifically, the project scope includes the:
* AsciiDoc language syntax and grammar (e.g., EBNF, PEG, ANTLR4, etc.)
** doctype-specific structures and required elements
** designated extension points
* ASG: an encoded form of the parsed document for use in developing a language-agnostic TCK (e.g., JSON)
* TCK: Technology Compatibility Kit for verifying compliance of an AsciiDoc language processor
* DOM API: in-memory semantic representation of the encoded information in the AsciiDoc document
* Processor API (load, convert)
** Converter API
* Extension API
** Extended syntax processors (e.g., custom block or macro)
** Resolvers (e.g., path and attribute resolvers, ID generator)
** Parse events and lifecycle interceptors (e.g., input processor, output processor, tree processor)
** Integration adapters: syntax highlighter, STEM, bibliography, docinfo
* Expected converter behaviors (e.g., toc, ID generation, icon type, safe mode)
* Internal and external referencing system: (e.g., xrefs, includes, images)
* Reference converter and output format (e.g., HTML with reference stylesheet and/or DocBook)
* Built-in attribute names, values, and behaviors and reserved attribute namespaces
* AsciiDoc media type (MIME) and .adoc file extension
The project also provides the:
* AsciiDoc language documentation for writers
* AsciiDoc API documentation
NOTE: The project scope is also published on the https://projects.eclipse.org/projects/technology.asciidoc/governance[Governance page] of the project site.
== Scope changes
Any revisions to the project scope, with the exception of minor corrections that don't change semantic meanings or intent, require a https://www.eclipse.org/projects/dev_process/#6_3_8_Restructuring_Review[restructuring review] and approval by a super-majority of the Steering Committee.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment