nextcloud / nextcloud/academy

Write the 18 standalone modules (needs routing first)

Open
#15 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
2
Forks
1
Avg merge
1d 2h
Merged PRs (30d)
7

Description

Part of the content gap. The manifest declares 18 standalone modules across 5 categories; only one is written.

Standalone modules have no prerequisites and are meant to be readable on their own, separately from the two tracks.

Category Modules
development_tooling standalone-env-setup ✅ (= content/shared/setup.md), standalone-dev-environment, standalone-git-workflow
app_quality standalone-l10n, standalone-reuse, standalone-testing, standalone-psalm, standalone-accessibility, standalone-taint
publishing_maintenance standalone-app-store, standalone-compatibility
design_frontend standalone-design-system, standalone-theming
deeper_topics standalone-federation-concepts, standalone-php-vs-exapp, standalone-gdpr, standalone-contributing-libraries, standalone-smart-picker

Blocked on a structural decision

course-v2 has no routing for standalone modules. Routes are [track]/[level]/[module], and lib/content.ts resolves content as content/<track>/<level>/<index>.md. Standalone modules have no track or level, so they need either a route of their own or a synthetic track. The only written one is currently reachable as content/shared/setup.md.

Decide the shape before writing 18 modules against it.

Ready source material

  • The troubleshooting extra in course/files/tutorials/ was judged directly adaptable.
  • szaimen/nextcloud-easy-test suits a "reproducing bugs" module.
  • Tutorial 5 (Smart Picker) is the source for standalone-smart-picker — tracked separately.

Done when

Standalone modules are routable, and each has content or an explicit decision to drop it.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with lib/content.ts and the existing content/shared/setup.md entry, then inspect how the current [track]/[level]/[module] routes resolve content. Decide and document a routing shape for modules without a track or level before drafting content. Done means standalone modules are routable and each listed module has content or an explicit decision to drop it.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
content, documentation, web-dev
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.