Documentation does not appear after registering module

Plugins
1

I recently registered my first Caddy module. It can now be downloaded on the Caddy download page, but it does not have any description. It also have its own page in the Caddy documentation, but nearly empty. And it does not appears in the module listing.

Inspired by the source code of other modules, I tried to add some documentation comments and struct tag fields, but it did not work.

What should I do ?

2

And, yes, I did not forget to push the “Rescan” button in the Caddy module dashboard.

3

There’s an error due to Go version mismatch between what your module requires and what we have on the server. I’m looking into it.

2 Likes
4

Try a rescan now

1 Like
5

It does not work anymore:

Rescan failed
Sorry, something went wrong:
502 error

:frowning_face:

6

Aaahhhh uh oh :sweat_smile: let me check

2 Likes
7

Try now :slight_smile:

2 Likes
8

OK. Scan works now and Pixbooster is now on the global list. But description and documentation are still missing everywhere…

1 Like
9

The pages are cached. It takes time for the cache to expire and the new values to show.

1 Like
10

Great! But the module list was updated and the description is missing, so I think there still is a issue there.

11

Well, Pixbooster has disappeared again from the module list… :crazy_face:

12

This bug sounds familiar…

We probably need to devote some energy to fixing our docs backend but I do not have the time right now…

3 Likes
13

I encourage you to find the time soon: it’s quite demotivating for module developers not to see their work referenced and documented here…

1 Like
14

I know. Sorry. We just have limited resources and lots to do! Gotta release 2.8, then revamp our docs, so maybe after the docs are done, we can work on the module documentation system.

2 Likes
15

Don’t be sorry! I did not meat it that way… I encourage you i.e.I wish you courage :smiley:

1 Like
16

That’s a quirk of French vs English, the connotation of “encourage” is a bit different. In French the emphasis of the word is on “courage” but in English it usually has the connotation of “adding pressure” :sweat_smile:

3 Likes
17

So it’s my turn to be sorry, for my bad English! Luckily, we have a Canadian :hugs: to fill the gap! Are you from Quebec?

1 Like
18

Franco-Ontarian. Pretty different from Quebec French.

But no worries, it’s obviously a really subtle thing, no harm done.

3 Likes
19

This topic was automatically closed after 30 days. New replies are no longer allowed.