Admin half in the fluentcms-plugin template

Open
#3,293 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
csharp
Domain
backend, testing

Research direction

Read docs/planning/admin-technical-spec.md sections 5.1, 6.2 and 10.4, then inspect templates/fluentcms-plugin and test-templates.sh. Confirm A-18 is available before implementing the manifest test; A-19 and A-22 are needed for the disabled-plugin acceptance check. Done means the generated template builds and tests with and without the admin half, its manifest test detects a removed contribution, and the referenced half uses only the two named FluentCMS packages.

Written by the indexing model from the issue text.

Description

area:admin type:feature

Problem

Row 8.17 asks that the plugin template gives a working plugin. dotnet new fluentcms-plugin writes the server half only, so an author of a plugin has no example of an admin half, its manifest or its test.

Proposal

  • templates/fluentcms-plugin gains {name}.Admin, a Razor Class Library that references FluentCMS.Admin.Abstractions and FluentCMS.Admin.Components only: a page with its menu item, a settings page for the plugin's area, a dashboard widget, its resources, and fluentcms-admin.json.
  • A test project with the manifest test of A-18 and one component test of the page.
  • An option of the template leaves the admin half out, for a plugin without one.
  • test-templates.sh builds and tests the output with and without the half.
  • The template's README says how an app references the half, since the first-party app holds the first-party halves only (6.3).

Acceptance

  • dotnet new fluentcms-plugin builds and its tests pass, with the admin half and without it
  • The half's manifest test passes as generated, and fails when a contribution is removed from the file
  • An app that references the generated half shows its page, menu item, settings page and widget, and none of them in a site where the plugin is disabled (checked once A-19 and A-22 are merged, in the template's test or the end-to-end shard)
  • The half references no FluentCMS package beside the two named

Design: docs/planning/admin-technical-spec.md, sections 5.1, 6.2 and 10.4 (A-23). Row 8.17. Needs A-18; the last acceptance row needs A-19 and A-22. Size: S.

Dominant language
C#
Stars
569
Forks
107
Avg merge
2h 49m
Merged PRs (30d)
397

Getting set up

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.

More from fluentcms/FluentCMS

All issues in fluentcms/FluentCMS

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.