·   ·  53 posts
  •  ·  632 friends

100 D-Days Challenge

Today, we are starting a 100-day challenge to update and expand UNA CMS documentation. This is an open challenge for us. We are committed to completing it, and we ask you, the UNA community, to hold us accountable.

Why?

  • UNA Documentation is poor. It’s outdated and very limited. We need to make it exceptional. Not just OK, or good… it should be amazing.
  • We are tuning an AI model to provide support for UNA operators and developers. A good model requires up-to-date reference data.
  • As we work on the Docs, we test everything thoroughly. In 100 days, we should have a stable release of UNA 14 ready, and this time around, it must be very well-tested.
  • With community involvement, we will be able to not just write docs, but identify problems and work out new solutions.

Rules

  • Every day of the next 100 days, including weekends, we will publish or update at least one new Docs page. On good days, we may be able to do more than one.
  • Every day, we will start a discussion related to the published Doc and invite the community to suggest edits, ask questions, critique, and share opinions on the subject.
  • Before publishing any new page, we will incorporate all relevant and useful updates posted in discussions into previously published docs.

If you have recommendations for specific pages that need updating, or requests for docs on any specific topic, please post in replies to this discussion.

It’s ON!

💓 4 😆 6 😲 4 😥 6 😠 24
  • 2335
  • More
Comments (10)
    • As a new Una user, I strongly support this plan. Your efforts are welcome and valued :)

      • Yay, so happy that you're working on documentation! As I've been learning UNA I've been thinking that this app would be so much more accessible (and get more users!) with better documentation. I have had to simply install it, and keep turning things off and on again, and make a bunch of test profiles and test posts all over the place just to figure out what all the settings do!

        Right now I have a deadline by which I need to complete all the basic areas of our UNA site (April 13-14), but when that is complete (and after I take a couple week break lol), if you are interested, I would love to contribute by helping with writing documentation and tutorials. I have a "Guide to UNA" written already that's designed to explain basic concepts to a brand new user with zero technology experience. It's very tailored to our community - and it talks about differences between UNA and Wordpress since we migrated from Wordpress to UNA - but would be easy to adapt!

        I can't post links but here's a preview:

        image_transcoder.php?o=sys_images_editor&h=1854&dpx=1&t=1710936905I have just gotten our community site to the point where it's ready for people to join, with customized membership levels, and profiles and discussions are fully operational, and I'm really impressed with how tiny the list of CSS code I had to write is so far!

        • Great news.

          A good way to keep us coming back.

          Michel - Meta-Travel Community Hub

          • I so love this ....when will you guys stop make us so excited, lol. Excellent!!!!!

            • Yes, developer documentation is in need of a major overhaul. It is so incomplete and missing so much, it makes it hard to develop correctly.

              There should be good documentation on the bx_alert system, exactly how it interacts and what can be intercepted and what all creates alerts. Since this is a major way to create modifications without core changes. It needs amazing documentation.

              I'm a pretty smart, yet simple guy. If I read something, and it is docs from say UNA staff, or your website, it should include every step. You must write documentation as if the person who is reading knows nothing about what you are doing, and if he follows the steps from point a to point b, it should work. Not take hours to figure out a step wasn't included or "assumed".

              UNA is buggy, it will take a lot to hold you to the well tested release of UNA 14 stable. But I think differently than most, and my grey hat hacker side has me poking things. We will see what all I find I can break. 😎👍

              Things have come a long way since my Dolphin 5 days. Its been nearly two decades. But documentation has been a issue since then. If you really mean it, do it. And do it well.

              • Service calls is another area that needs much more documentation.

                Forms should have an example in module like page and menus does. Forms are a bit more work an understanding, and would be great to see an example in code.

                • I have to say you are smashing the documentation challenge!!! It is an excellent resource; I might even be able to implement my own community now. Keep up the great work :)

                  • Enhancing Documentation for the "UNA" Platform

                    Great news! I have been eagerly awaiting comprehensive and updated documentation for each available version of the "UNA" platform. In my opinion, the horizontal and vertical development of a social network website isn't feasible without a robust cluster system. Therefore, detailed documentation for Docker and Docker Swarm is essential, as it would facilitate the quick installation and expansion of the platform. An even better solution would be a Helm Chart and Kubernetes (K8s) recipe, providing optimal deployment and scaling capabilities.

                    Documentation is crucial for both developers and users. This would allow everyone to access a help module and view this online documentation directly on their platform or on "UNA." Each module should contain files with updated documentation for each version, including core documentation. The help module should pull this information directly from these files to display it online for each user category: admin, manager, and user. Additionally, this documentation could be divided by actions and user levels, making it directly accessible online for everyone. Drupal has a very effective system similar to this. The text could be part of an i18n (internationalization) multilanguage module, with keys editable directly online by administrators, similar to Drupal's translate key function. This could then be sent to a central UNA hub so sites administrators or editors can improve the platform through feedback and enhance documentation directly online in any language.

                    At one point, Dolphin had something similar, with an info icon on each module where users could access a popup for details. This feature greatly enhanced user experience by providing immediate, relevant information. Unfortunately, this function disappeared in UNA.

                    An AI model could generate corresponding info files for each file in the "UNA" platform, in any extension such as .MD or .txt. This AI-generated documentation could then create a directory hierarchy that the help module could read, ensuring all information is systematically organized and easily accessible. For each user category, it would be sufficient to add tags at the programming level to ensure the documentation is appropriately categorized and displayed.

                    Suggestions for Generating Documentation to Improve the Platform by chat-gpt4

                    Automated Documentation Tools:

                    • Doxygen: Generate documentation from annotated source code.
                    • Sphinx: Particularly useful for Python projects but can be extended to other languages.
                    • Swagger: For API documentation, making it easier to create interactive documentation.

                    Integrated Help System:

                    • Develop an integrated help system within the platform where users can access context-sensitive help. Each feature or module could have a help icon that, when clicked, displays relevant documentation.
                    • Use a tooltip system that provides brief information about each feature or function when the user hovers over it.

                    Modular Documentation Approach:

                    • Structure documentation in a modular way, where each module/component has its own section. This makes it easier to update and maintain documentation as the platform evolves.

                    Version Control for Documentation:

                    • Use version control systems like Git to manage documentation changes. This ensures that users can access documentation that corresponds to the version of the software they are using.

                    Tagging and Categorization:

                    • Implement a tagging system to categorize documentation by user role (admin, manager, user) and by functionality. This helps users find relevant information quickly.

                    Interactive Tutorials and Examples:

                    • Provide interactive tutorials and examples that guide users through common tasks. These can be in the form of video tutorials, step-by-step guides, or interactive demos.

                    Feedback System:

                    • Implement a feedback system within the documentation where users can suggest improvements, report errors, or ask for clarifications. This helps keep the documentation user-centric and continuously improving.
                    • Additionally, place a feedback button on every page of the documentation to make it easy for users to provide input at any point.

                    Searchable Knowledge Base:

                    • Develop a comprehensive, searchable knowledge base that includes FAQs, troubleshooting guides, and user forums. This can help users solve problems without needing direct support.

                    Regular Updates and Audits:

                    • Regularly update the documentation to reflect changes in the platform. Conduct periodic audits to ensure the accuracy and relevance of the content.

                    Collaborative Documentation:

                    • Encourage community contributions to the documentation. Platforms like GitHub allow users to contribute to documentation repositories, ensuring a broader range of insights and updates.

                    By implementing these strategies, the documentation can be significantly improved, providing a more robust and user-friendly experience for both developers and end-users. This will enhance the overall usability and attractiveness of the platform.

                    • am looking for someone who can deploy una for me. Someone expert installing and setting up una

                      • Andrey do you intend to complete your 100 D-Day Challenges?

                        Login or Join to comment.