[tw5] Re: Tiddly as a knowledge base alternative to Jira and Wikimedia or blogs for software technical deocumentation

[C J]

Hi everybody, 
Sorry for the delay. Finally, I found someone in the room next to us who 
started a local Wikimedia project 3 years ago. I have decided to use this 
one.
Thank you for all your answers and messages. 
It was really great to have your support and see that some of you are 
thinking to solutions to problems like mine.

Best regards.
Cedric J.

Le dimanche 31 janvier 2021 à 19:06:55 UTC+1, cj.v...@gmail.com a écrit :

> Aside lol:
>
> Every time I see "gentlemen's agreement", I think:  
> https://twitter.com/brysonbort/status/941784237946089472
>
>

-- 
You received this message because you are subscribed to the Google Groups 
"TiddlyWiki" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to tiddlywiki+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/tiddlywiki/29fbae54-65e7-4fa7-b479-8b3cb979dff9n%40googlegroups.com.

Re: [tw5] Re: Tiddly as a knowledge base alternative to Jira and Wikimedia or blogs for software technical deocumentation

[C J]

@PMario,

Yes my boss, the owner of the company wants that so does his advisor. My 
manager also wants that but nobody want to spend much time. 
We use Jira for tasks management: creating, assigning and updating tasks 
from ''To Do" to "Done".
We use GitLab to manage the versions of our codes.
There is no CI/CD tool like Travis and Jenkins. I don't have experience 
with CI systems but I am ready to learn.
What I **really** want is a really private collaborative blog-like with 
tags and a clean interface.
I want to document :

   - Projects goals
   - Choices (why we did things the way we did) 
   - APIs with the endpoints, what they return and the versions
   - Tutorials: how to set up and start apps
   - Use cases
   - Related knowledge, for example I made a Kubernetes powerpoint based 
   training last week for my team
   - FAQ
   - Updates



Le samedi 30 janvier 2021 à 16:54:28 UTC+1, PMario a écrit :

> On Saturday, January 30, 2021 at 2:28:54 PM UTC+1 work.ced...@gmail.com 
> wrote:
>
> I am interested in the git synchronisation and the different 
>> aforementioned plugins and approaches. I do not know how to do the git sync 
>> and I would need an example.
>>
>> However, I would like to make it collaborative. Ludwa06 and Finn said 
>> that it is difficult for a team. 
>> I do not know GitHub pages. Is it free? 
>>
>
> Yes. BUT I think it only works for _public_ content and I doubt that's 
> what you want.
>  
>
>> We use a private GitLab business account so I am not sure that it would 
>> be the solution.
>>
>
> We (TW) do have a GitLab saver and GitLab also has a "pages" option. 
>
> ... But if you use GitLab and the CI/CD elements, it will also be possible 
> to dynamically create "parts" or "all" of the wiki content in a "scripted" 
> way. You only would need to "compile" the wiki after a commit is made, or 
> may be if you TAG a software version. 
>
> BUT ... This would be the second step of the game. 
>
> In the OP you wrote that some of the "maintainers" of the wiki sit in the 
> same room. .. So "locking" the wiki would be simple. Just ask the others to 
> save their wiki, if they are editing it. ... I know that this is far from 
> perfect, but if you are at the same place -- it's simple. 
>
> To be honest I will compare it to Notion, Bookstack and Tettra.
>>
>
> I think the only "fair" comparison would be with Bookstack, since it can 
> be "self-hosted" and is open-source. All the others are proprietary 
> products.
>
> But I think you did land here at the TW group, because it can be a "single 
> page" wiki, that can be stored alongside 1 project, with no extra 
> dependencies. For Bookstack, imo you will need your own DevOps person that 
> takes care of the server-side and keep it running. 
>
> TiddlyWiki is a single html file, that imo easily can contain the text 
> content needed. ... Images should be "external", but that shouldn't be a 
> big problem with GitLab-pages. 
>
> Knowing that we are a very small company (14 employees including 4 
>> full-time developers) I have to find a free solution while escaping from 
>> the messy situation where nobody knows how the guy who is just sitting next 
>> to you installs software, runs programs, writes his code and deploys it, 
>> etc. 
>>
>
> In the OP you wrote, that you use Jira, to manage your code. In the 
> response above you wrote you have a GitLab business account ... So I'm a 
> bit confused. Both software stacks do similar things ... 
>
>  
>
>> This situation has consequences: if someone is absent or leaves the 
>> company the onboarding is very hard. Last Monday I spend all my time trying 
>> to set up a program. Finally, on Tuesday its developer told me that he has 
>> a lot of steps to explain to me, that I have to follow to start the 
>> applications with many installations.
>>
>
> I think that's a perfect match for a TW. 
>  
>
>>  This is my case and the reason for what I am looking for a private Wiki.
>>
>
> As I wrote, it may be possible, to create parts of the wiki automatically, 
> if you use a CI system. 
>
> BUT it would need a lot more info, what you *really* want. 
>
> --
>
> There is 1 question left: ... Is it your idea to create a knowledge base, 
> or does everyone desperately want it. IMO it's important that it's 
> sanctioned from the management. 
>
> -mario
>
>
>

-- 
You received this message because you are subscribed to the Google Groups 
"TiddlyWiki" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to tiddlywiki+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/tiddlywiki/2bb5a755-0a8c-447b-8c9a-5f268e01cf27n%40googlegroups.com.

Re: [tw5] Re: Tiddly as a knowledge base alternative to Jira and Wikimedia or blogs for software technical deocumentation

[C J]

I also would like to add that the backend developer wants to leave the 
company and that I am new there so the solution that I am looking for 
should be very easy to set up and use quickly. I hope that Tiddly will be 
the right one. 

Le samedi 30 janvier 2021 à 14:28:54 UTC+1, C J a écrit :

> Thank you for your answers! 
>
> I am interested in the git synchronisation and the different 
> aforementioned plugins and approaches. I do not know how to do the git sync 
> and I would need an example.
>
> However, I would like to make it collaborative. Ludwa06 and Finn said that 
> it is difficult for a team. 
> I do not know GitHub pages. Is it free? We use a private GitLab business 
> account so I am not sure that it would be the solution.
>
> If you could provide me with a recipe to use it like Finn with the 
> implementation of Charlie and Sylvain's ideas I will try it on Monday.
>
> To be honest I will compare it to Notion, Bookstack and Tettra. Knowing 
> that we are a very small company (14 employees including 4 full-time 
> developers) I have to find a free solution while escaping from the messy 
> situation where nobody knows how the guy who is just sitting next to you 
> installs software, runs programs, writes his code and deploys it, etc. 
>
> This situation has consequences: if someone is absent or leaves the 
> company the onboarding is very hard. Last Monday I spend all my time trying 
> to set up a program. Finally, on Tuesday its developer told me that he has 
> a lot of steps to explain to me, that I have to follow to start the 
> applications with many installations.
>
>  This is my case and the reason for what I am looking for a private Wiki.
>
> Best Regards.
> Cedric
>
> Le samedi 30 janvier 2021 à 13:57:48 UTC+1, flanc...@gmail.com a écrit :
>
>> @ludwa6 does make a point, at least in my opinion. A wiki is most 
>> definitely a powerful tool, and tiddlyWiki holds the potential to make a 
>> great, modernized version of one. The issue with using tiddlyWiki as a 
>> group or team wiki, in my experience, is implementing proper controls. For 
>> example, in my collaborative tiddlyWiki at wiki.finnsoftware.net, I’ve 
>> removed all traces of control panel, trash button, and anything to find 
>> them, including advanced search to prevent users from modifying the “core 
>> vitals” of the software. TiddlyWiki was made to be a personal notebook, and 
>> hence has not had proper testing (or documentation) at a team level. Anyone 
>> attempting to do this will surely face bugs and issues, and the main thing 
>> needed to do all of this correctly is patience. 
>>
>> The second point I will make is questioning to the extent at which Cedric 
>> would like to use TiddlyWiki. It is one thing to make a tiddlyWiki hosted 
>> on GitHub that displays your changes. It is quite another to make it fully 
>> collaborative, even with all the amazing plugins available. I one again 
>> would stress the importance of using GitHub Pages over a server to Cedric 
>> if he seeks to make the wiki fully collaborative, as at least that has a 
>> little bit of testing for this purpose. 
>>
>> Regards, 
>>  Finn Lancaster
>>  Software Developer finnsoftware.net 
>>  Implementing TiddlyWiki at wiki.finnsoftware.net 
>>
>> On Sat, Jan 30, 2021 at 7:32 AM Hans Wobbe  wrote:
>>
>>> ludwa6:
>>>
>>> Thanks for you post.  It resonated with me since its insights are 
>>> consistent with me experience.  I also appreciate the Rufus Pollack link
>>>
>>> Regards,
>>> Hans
>>>
>>>
>>> On Saturday, January 30, 2021 at 5:29:12 AM UTC-5 ludwa6 wrote:
>>>
>> The UseCase that Cedric has shared falls squarely in the middle of a 
>>>> problem space that TW is very well-suited to solve, i think, and much as i 
>>>> resonate with the ideas shared by Finn and Charlie have shared, what i'm 
>>>> really hungry for is a working example of some solution that solves a 
>>>> UseCase as close as possible to that which the OP here describes. 
>>>>
>>>> Reason i ask is: much as i love wiki for personal KM & productivity 
>>>> management (have used different desktop wikis over many years, and finally 
>>>> settled on TW5 as the best solution for me), every time i have tried to 
>>>> deploy it as a workgroup solution, it has failed to achieve sufficient 
>>>> traction to warrant its continued maintenance. 
>>>>
>>>> My theory of cause about this could be thought of as the flipside of 
>>>> the very coin that mak

Re: [tw5] Re: Tiddly as a knowledge base alternative to Jira and Wikimedia or blogs for software technical deocumentation

[C J]

Thank you for your answers! 

I am interested in the git synchronisation and the different aforementioned 
plugins and approaches. I do not know how to do the git sync and I would 
need an example.

However, I would like to make it collaborative. Ludwa06 and Finn said that 
it is difficult for a team. 
I do not know GitHub pages. Is it free? We use a private GitLab business 
account so I am not sure that it would be the solution.

If you could provide me with a recipe to use it like Finn with the 
implementation of Charlie and Sylvain's ideas I will try it on Monday.

To be honest I will compare it to Notion, Bookstack and Tettra. Knowing 
that we are a very small company (14 employees including 4 full-time 
developers) I have to find a free solution while escaping from the messy 
situation where nobody knows how the guy who is just sitting next to you 
installs software, runs programs, writes his code and deploys it, etc. 

This situation has consequences: if someone is absent or leaves the company 
the onboarding is very hard. Last Monday I spend all my time trying to set 
up a program. Finally, on Tuesday its developer told me that he has a lot 
of steps to explain to me, that I have to follow to start the applications 
with many installations.

 This is my case and the reason for what I am looking for a private Wiki.

Best Regards.
Cedric

Le samedi 30 janvier 2021 à 13:57:48 UTC+1, flanc...@gmail.com a écrit :

> @ludwa6 does make a point, at least in my opinion. A wiki is most 
> definitely a powerful tool, and tiddlyWiki holds the potential to make a 
> great, modernized version of one. The issue with using tiddlyWiki as a 
> group or team wiki, in my experience, is implementing proper controls. For 
> example, in my collaborative tiddlyWiki at wiki.finnsoftware.net, I’ve 
> removed all traces of control panel, trash button, and anything to find 
> them, including advanced search to prevent users from modifying the “core 
> vitals” of the software. TiddlyWiki was made to be a personal notebook, and 
> hence has not had proper testing (or documentation) at a team level. Anyone 
> attempting to do this will surely face bugs and issues, and the main thing 
> needed to do all of this correctly is patience. 
>
> The second point I will make is questioning to the extent at which Cedric 
> would like to use TiddlyWiki. It is one thing to make a tiddlyWiki hosted 
> on GitHub that displays your changes. It is quite another to make it fully 
> collaborative, even with all the amazing plugins available. I one again 
> would stress the importance of using GitHub Pages over a server to Cedric 
> if he seeks to make the wiki fully collaborative, as at least that has a 
> little bit of testing for this purpose. 
>
> Regards, 
>  Finn Lancaster
>  Software Developer finnsoftware.net 
>  Implementing TiddlyWiki at wiki.finnsoftware.net 
>
> On Sat, Jan 30, 2021 at 7:32 AM Hans Wobbe  wrote:
>
>> ludwa6:
>>
>> Thanks for you post.  It resonated with me since its insights are 
>> consistent with me experience.  I also appreciate the Rufus Pollack link
>>
>> Regards,
>> Hans
>>
>>
>> On Saturday, January 30, 2021 at 5:29:12 AM UTC-5 ludwa6 wrote:
>>
> The UseCase that Cedric has shared falls squarely in the middle of a 
>>> problem space that TW is very well-suited to solve, i think, and much as i 
>>> resonate with the ideas shared by Finn and Charlie have shared, what i'm 
>>> really hungry for is a working example of some solution that solves a 
>>> UseCase as close as possible to that which the OP here describes. 
>>>
>>> Reason i ask is: much as i love wiki for personal KM & productivity 
>>> management (have used different desktop wikis over many years, and finally 
>>> settled on TW5 as the best solution for me), every time i have tried to 
>>> deploy it as a workgroup solution, it has failed to achieve sufficient 
>>> traction to warrant its continued maintenance. 
>>>
>>> My theory of cause about this could be thought of as the flipside of the 
>>> very coin that makes wiki such a powerful tool for quickly building an 
>>> extensive knowledge base, and a PERSONAL interface to same: it's fast, it's 
>>> "InterTWingly," it can (if built on such sound architecture as TW5) 
>>> accommodate whatever computer language you might be partial to, etc.  
>>> Problem is, when it comes to the languages that stand at higher levels up 
>>> the KM stack -i.e. for naming and tagging and classifying knowledge- we all 
>>> have different ideas. I guess that's what Rufus Pollock means, @charlie, 
>>> when he talks about the shift that we'll see 
>>> 
>>>  
>>> in the coming Componentization Revolution, when that 90:10 ratio of 
>>> Content:Interface will flip around to its mirror image.  With granular 
>>> content everywhere, interface-building becomes the name of the game.  
>>> Question then becomes: how do we make of that interfac

Re: [tw5] Tiddly as a knowledge base alternative to Jira and Wikimedia or blogs for software technical deocumentation

[C J]

Thank you for your answer Finn!
Do you find it easy to make a tree file/folder system with tags and 
hyperlink and and then establish relations between different topics that 
share or leverage common resources? 
How would you start documenting a three tier web application for example? 
Is Debian an obstacle?
Cordially
Cedric

Le vendredi 29 janvier 2021 à 13:04:26 UTC+1, flanc...@gmail.com a écrit :

> Hi Cedric, 
>  It’s nice to know that someone else is using tiddlyWiki for software 
> development organization! From my short experience (about a month), I’ve 
> actually found TiddlyWiki to be perfect for this sort of thing. The wide 
> range of plugins available mean that the software is very flexible for 
> anything you need, for example, there are very good code plugins that 
> support web, c, Python, and Java languages. In addition to this, the saving 
> of tiddlyWiki’s is also super easy, you can make a collaborative wiki with 
> just a few minutes by syncing it via GitHub pages. If you have any 
> questions, or need further info on how to do any of these things described, 
> feel free to respond here or email me directly. 
>
> Regards, 
>  Finn Lancaster 
>  www.finnsoftware.net
>  Implementing tiddlyWiki at wiki.finnsoftware.net
>
> On Fri, Jan 29, 2021 at 4:41 AM C J  wrote:
>
>> Hi everybody.
>>
>> I am Cedric, a French Software developer and I start working in a very 
>> small (4 people) team o software developers in a very small company.
>>
>> Unfortunately the knowledge is neither organized either shared between 
>> people who yet work in the same room and I want to start documenting 
>> projects and applications while managing updates and versions. 
>>
>> Knowing that we already have a Jira to manage our project but we cannot 
>> afford for a team plan I was looking for a free open source wikimedia like 
>> or a home made blog using Wagtail when I discovered Tiddly. 
>>
>> Do you think that it can be an suitable tool for me?
>>
>> Best regards.
>> Cedric J. 
>>
>> -- 
>> You received this message because you are subscribed to the Google Groups 
>> "TiddlyWiki" group.
>> To unsubscribe from this group and stop receiving emails from it, send an 
>> email to tiddlywiki+...@googlegroups.com.
>> To view this discussion on the web visit 
>> https://groups.google.com/d/msgid/tiddlywiki/17edcda9-b33b-4a27-a6c6-d6a12aeff5c3n%40googlegroups.com
>>  
>> <https://groups.google.com/d/msgid/tiddlywiki/17edcda9-b33b-4a27-a6c6-d6a12aeff5c3n%40googlegroups.com?utm_medium=email&utm_source=footer>
>> .
>
>

-- 
You received this message because you are subscribed to the Google Groups 
"TiddlyWiki" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to tiddlywiki+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/tiddlywiki/ea36-8a41-43ca-bca9-9085477e1cd8n%40googlegroups.com.

[tw5] Tiddly as a knowledge base alternative to Jira and Wikimedia or blogs for software technical deocumentation

[C J]

Hi everybody.

I am Cedric, a French Software developer and I start working in a very 
small (4 people) team o software developers in a very small company.

Unfortunately the knowledge is neither organized either shared between 
people who yet work in the same room and I want to start documenting 
projects and applications while managing updates and versions. 

Knowing that we already have a Jira to manage our project but we cannot 
afford for a team plan I was looking for a free open source wikimedia like 
or a home made blog using Wagtail when I discovered Tiddly. 

Do you think that it can be an suitable tool for me?

Best regards.
Cedric J. 

-- 
You received this message because you are subscribed to the Google Groups 
"TiddlyWiki" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to tiddlywiki+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/tiddlywiki/17edcda9-b33b-4a27-a6c6-d6a12aeff5c3n%40googlegroups.com.