Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Converting gap-analysis doc to work with issues #214

Closed
r12a opened this issue Feb 2, 2020 · 1 comment
Closed

Converting gap-analysis doc to work with issues #214

r12a opened this issue Feb 2, 2020 · 1 comment

Comments

@r12a
Copy link
Contributor

r12a commented Feb 2, 2020

We are converting the template for the gap-analysis documents so that most of the content can be written/edited in github issues. This makes editing easier, but also establishes a GH issue thread that can bring together discussion, comments, and suggested text for developing the text on a given topic.

The document at https://w3c.github.io/alreq/gap-analysis/ will automatically retrieve the appropriate content from the GH issues list. Changes to the latter will be immediately visible in the document if you refresh your browser page.

By reducing the complexity involved in maintaining the document in HTML and using the GH pull request process, it is hoped that this will make it easier for people to contribute to the document, as well as providing a handy list of sections in the issue list when filters are applied.

As we convert the document to the template, you will see a flurry of issues added to this repository. Apologies in advance for that.

@r12a r12a added the editorial label Feb 2, 2020
@r12a
Copy link
Contributor Author

r12a commented Feb 5, 2020

This has been done.

From now on, if we want to change the content of the gap-analysis doc, it's a question of raising a new issue (if it's a new topic), or editing (or proposing edits for) an existing issue. (Or closing the issue, which will remove the content from the document.)

@r12a r12a closed this as completed Feb 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant