Proposal: Testing and Debugging Project

Top level definition of the tandem project

Executive Summary:

create a companion document to the RedwoodJS Tutorial which explains the concepts of testing and debugging using the Tutorial application as the context.

Introduction

This project expands on existing chapters in RedwoodJS Docs:

all of which are essential parts of developer workflow, by adding the description of the concept of Debugging and demonstrating the use of all these tools and methods in the context of creating the RedwoodJS Tutorial application.

This application is chosen as the context, because is really well explained in the Tutorial and is complex enough to expand the examples already presented in the Tutorial like Building a Test Runner. Similarly, the Debugging chapter of tandem will expand on information presented in Windows Development Setup and Windows Subsystem for Linux Setup

Tools

Actions

Note that this proposal addresses Redwood community members (while it does not preclude Redwood Core Team members, who are interested in helping document the application development use of the above listed tools in the context of Redwood app development. It is not expected that authors of this proposal write all these documents (contents of this project) – the majority of that effort falls on the community members volunteering to participate.

Before expecting comments from Redwood Community and anyone else who wants to supply them, we will write several documents to suggest the content and the style

Once the feedback is complete, we will merge this with the current content and present this data as the real definition of this project.


Status on 04/09/2022

Introducing the first draft of RedwoodJS Community Library project described here. In order to minimize the size of this Discourse discussion as well as impact on ongoing work of the core team, the application itself lived on my own repo.

In order to facilitate the discussions on this project, while providing enough content, I will start “filling” the testing chapter. The fact that so far there is one vote expressing interest is not really relevant as there is no information on this project available yet - other than this project expects RW contributors write parts of it.

Status on 04/013/2022

Reached the level where this project would benefit from comments by core team members, which may care about the aims of it. Please check:

The plan is to solicit members of rw community to fill on whatever is not written in this site, so it is critically important to ensure that this project “has the back” of the core team.

Status on 04/014/2022

It is difficult to create this project, at the time when parts of it appear in various core team’s members projects. In other words, I was hoping that there will be some minimal coordination that would help not addressing the same thing more than once. So, part of my daily task is to try to read all current updates and make references in sections where a pointer to some currently published just appeared.

The purpose of this project is to enable RW “customers” (community members that use RW and are not core team members) to write docs on how to use RedwoodJS. At the same time it is unlikely that this site that extends the official RW docs site, will be of much use without the critical comments and eventual adoption from core team members.

Current scope of the application (not all chapters contain data - as something needs to created by the community members :wink:), shown below:

3 Likes