Forum > Documentation (Maintaining -)

Uploading all project code for wiki samples in .zip format

<< < (2/5) > >>

trev:

--- Quote from: Nimral on February 01, 2022, 12:28:59 pm ---I wanted to contribute to the wiki and provide a complete code sample (including the lfm files) in zip format. Unfortunately the wiki will let me only upload several graphics file formats, but no zip archives.

Is there a way to provide a complete code sample project?
--- End quote ---

Someone pays for the disk space and bandwidth that the Wiki occupies which I believe is behind the restricted upload formats. My solution is simply to link to a SourceForge repo.

As for Forum attachments -- if I recall correctly -- these can be purged at any time for the same reasons.

dbannon:

--- Quote from: Nimral on February 01, 2022, 01:03:38 pm ---- Advocate to allow an archive format in the forum attachments, or
- Advocate to publish the complete code samples through [your?] git and put a link in the wiki?
- Something else?

--- End quote ---

Something else !   This came out a discussion about the existing collection of examples that are shipped with Lazarus. The feeling was that they are, in many cases, poorly documented, some are dated, some don't work and, as such, are not very useful to end users, especially new users.

On the other hand, there is a lot of valuable content in there and there could be a lot more if people like yourself, wanting to write a short tutorial had a easy place to put the sample code.

So, no, forum or wiki attachments are not the solution and shipping all the examples with Lazarus may not be a good idea either. Trev I think suggested an online repo and I suggested a metadata model to both classify and allow sensible searching.  So, the idea is that the repo you see will eventually end up in the FPC github site and a replacement Examples Window in Lazarus allows an end user to find and download just the example they want to play with.

There are already a number of examples in the 'kit' that relate to wiki based tutorials. That sounds just like what you were asking for. 

So far, I have classified about 50 examples, maybe 20% of the total. Its enough for me to get a feel of the quality there and I think my current category list needs some revision. For example, the "Techniques" category is too big, maybe needs to separate out "Drawing" At present, its just a proof of concept and a spare time activity for me.

But clearly, soon, it will need more people classifying and contributing and we need an indication from the Lazarus developers that we are on the right track still.

Davo

Nimral:

--- Quote from: dbannon on February 02, 2022, 12:25:59 am ---Something else !   This came out a discussion about the existing collection of examples that are shipped with Lazarus. The feeling was that they are, in many cases, poorly documented, some are dated, some don't work and, as such, are not very useful to end users, especially new users.

--- End quote ---

Yes. Yes. YES! I have been entering the Lazarus/Pascal world recently, and had a really hard time finding even the most basic things, and all of the critics above apply 110%.


--- Quote from: dbannon on February 02, 2022, 12:25:59 am ---So, no, forum or wiki attachments are not the solution and shipping all the examples with Lazarus may not be a good idea either. Trev I think suggested an online repo and I suggested a metadata model to both classify and allow sensible searching.  So, the idea is that the repo you see will eventually end up in the FPC github site and a replacement Examples Window in Lazarus allows an end user to find and download just the example they want to play with.

There are already a number of examples in the 'kit' that relate to wiki based tutorials. That sounds just like what you were asking for. 

--- End quote ---

This is exactly how things need to be done, IMHO. How can I contribute? I have worked on service/daemon development recently, and started to update the wiki as far as I could whenever I got something working I was happy with. The Windows sample is working perfectly, and I am currently working on the Linux version, I expect a tested code sample till tomorrow evening. Since I do always try to support both worlds with one source there will be some minor changes flowing back into the Windows version when Linux is running, and then the sample is done.

How can I add the sample to the git, once done? Do you give me write access? Or do you want the source files beforehand and see if they qualify?

Armin.

af0815:
There is another project for samples here in the forum.

dbannon:

--- Quote from: af0815 on February 02, 2022, 06:55:47 pm ---There is another project for samples here in the forum.

--- End quote ---

Is there ?   Where please ?

Davo

Navigation

[0] Message Index

[#] Next page

[*] Previous page

Go to full version