diff --git a/docs/company/reports/t2-2022/ontrack-report.md b/docs/company/reports/t2-2022/ontrack-report.md index 7080d93..2ecf6a2 100644 --- a/docs/company/reports/t2-2022/ontrack-report.md +++ b/docs/company/reports/t2-2022/ontrack-report.md @@ -62,6 +62,240 @@ Completed Tasks: - Creation of Audio System Interface Design Document - Testing of Voice Verification API + +#### Project Members (10) + +_Delivery Representative:_ md fahim mizi + +_Software Developers:_md fahim mizi + +OnTrack Overview +Author Information +Author(s): +Team: +Team (Delivery and/or Product) Lead: +Document Summary +Documentation Title: +Documentation Type: { Informative/Technical } +Documentation Information Summary: +Document Review Information +Date of Original Document Submission to GitHub: +Documentation Version: +Date of Previous Documentation Review: +Date of Next Documentation Review +Key Terms +Enter Key Terms here + +Key Links/Resources +Enter Key Links/Resources here + +Contacts for further information +Enter Contacts here + +Related Documents +Enter Related Documents here + +Introduction +Members of the OnTrack project concentrate on OnTrack, a Learning Management System (LMS) used by Deakin University, and its development and upkeep. A web program called OnTrack makes it easier to give students sign in and authenticate their credentials. It also supports students through task engagement. + +The OnTrack team has been tasked with developing additional features to improve users experience for easy usability. + +OnTrack is made up of several codebases for the front end and the back end, as well as a project for documentation: + +Ruby on Rails was used to build the OnTrack API's back end. +Built on Angular/AngularJS, Doubtfire-front web's end. +DoubtFire project documentation can be found at doubtfire.io. +The OnTrack team worked on adding numerous new features and improvements to OnTrack throughout: + +Implementations + +Check passwords +Reset OnTrack password +Documentation updates on OnTrack +README.md file +Written Down/Partially Carried Out + +Improvements to the admin panel and the portfolio +This document will explain each of those above, including references to pertinent artefacts. + +Document Objectives +This document is a transfer log for all the data and materials generated this trimester. The following items are included in the delivery package and handover document: + +The product owner was shown the initial feature docs or proposals that describe each item to be introduced. + +Files > Docs > OnTrack > Deployment > Software Requirements Specifications Check Passwords Document + +Files > Documents > OnTrack>Deployment> Software Requirements Specifications Reset Ontrack password Document + +Updates to the documentation can be found under Files > OnTrack>Documentation. + +Iteration retrospectives are presentations that offer an overview of the Ontrack development at the end of iterations 1 and 2. + +Initial Presentation Iteration. + +Presentation for iteration two. + +The Ontrack repository can be found at https://github.com/thoth-tech/documentation + +There are pull requests for each feature, along with modifications' examples. + +Long and Short Term Deliverables +Description Issues Contributors Iteration +Check passwords: With the use of this function, DoubtFire groups may verify that their passwords are correct and make any necessary modifications. Back-end pull request Front-end pull request Validating password in a secure manner Documented iteration 1 +Reset Ontrack password: Users cannot now reset their passwords after entering them into the system. This feature intends to add a different value to allow users to reset their password if they forget their original one. Back-end pull request Front-end pull request It was understanding the various API endpoints that rely on the current "without reset password" value and where it has to be changed to "Reset password" might be challenging. Documented iteration 1 +Documentation updates on Ontrack: This feature enables the DoubtFire update icon to allow users to access new releases and updates for simple system functions. These will enable them to use the system effectively and become accustomed to the latest upgrades.Front-end pull request The code had to be converted from Angular JS to Angular. The system update logic needed to be fixed because it was flawed. Documented iteration 2 +Readme file: This document aims to explain how to build up a working installation of Doubtfire on Windows using the Windows Subsystem for Linux (WSL). This document also includes instructions on how to alter the codebase correctly (using Visual Studio Code) so that there are no filesystem conflicts between Windows and Linux. Pull request The "step-x" pages automatically use a different template exclusive to step pages. A fix was necessary to guarantee that the "Step 1 of 4" title was generated appropriately. Documented iteration 1 +Planned Work +Description Issues Contributors Iteration +Open problems +Currently, the team only has one unresolved issue, which relates to a planned feature: + +As seen in the admin and portfolio enhancements feature document, the team is unsure how the admin and portfolio enhancements feature will be implemented on the back end. + +Lessons Learned +As an OnTrack team, one crucial lesson we discovered was the importance of experimenting with the Doubtfire environment on your own local computer. Instead than reading Ruby, Rails, or Angular tutorial after tutorial, working on a project is the greatest way to learn. + +The project customer should be contacted more frequently so they may offer greater guidance on the project. A larger backlog needs to be formed for choosing which activities to do. + +Product's High-Level Architecture +The components of the web application DoubtFire are as follows: + +Ruby on Rails' web framework, the Grape REST API development framework, and a backend (API) written in Ruby. The backend uses the Ruby on Rails Active Record ORM to interacting with a database (PostgreSQL for development and MySQL for production). Active Record migrations are used to control the database schema (Soni, 2017). + +A frontend currently primarily written in AngularJS and CoffeeScript is being upgraded to use Angular and TypeScript (Toal, Rivera, Schneider, & Eileen, 2016). + +User manual +Since Doubtfire is an established platform, there isn't a handbook available to help users access the front and back ends of the site. The readme file provided above may be a helpful starting guide; it will act as the foundation for Doubtfire's development ("Doubtfire-api/CONTRIBUTING.md at development · doubtfire-LMS/doubtfire-api”) + +XML +Here is a very basic XML sitemap that includes the location of a single URL: + +  +  +   +    http://www.example.com/foo.html  +    2018-06-04  +    + +Encode your file using UTF-8 encoding. + +Don't put anything other than URLs in the sitemap file. + +You can name the text file anything you wish, provided it has a .txt extension (for instance, sitemap.txt). + +General Sitemap Guidelines +Use consistent, fully-qualified URLs. Google will crawl your URLs exactly as listed. For instance, if your site is at https://www.example.com/, don't specify a URL as https://example.com/ (missing www) or ./mypage.html (a relative URL). + +A sitemap can be posted anywhere on your site, but a sitemap affects only descendants of the parent directory. Therefore, a sitemap posted at the site root can affect all files on the site, which is where we recommend posting your sitemaps. + +Don't include session IDs from URLs in your sitemap. This reduces duplicate crawling of those URLs. + +Tell Google about alternate language versions of a URL using hreflang annotations. + +Sitemap files must be UTF-8 encoded, and URLs escaped appropriately. + +Break up large sitemaps into smaller sitemaps: a sitemap can contain up to 50,000 URLs and must not exceed 50MB uncompressed. Use a sitemap index file to list all the individual sitemaps and submit this single file to Google rather than submitting individual sitemaps. + +List only canonical URLs in your sitemaps. If you have two versions of a page, list in the sitemap only the one you prefer to appear in search results. If you have two versions of your site (for example, www and non-www), decide which is your preferred site, and put the sitemap there, and add rel=canonical or redirects on the other site. + +If you have different URLs for mobile and desktop versions of a page, we recommend pointing to only one version in a sitemap. However, if you want to point to both URLs, annotate your URLs to indicate the desktop and mobile versions. + +Use sitemap extensions for pointing to additional media types such as video, images, and news. + +If you have alternate pages for different languages or regions, you can use hreflang in either a sitemap or html tags to indicate the alternate URLs. + +Non-alphanumeric and non-latin characters. We require your sitemap file to be UTF-8 encoded (you can generally do this when you save the file). As with all XML files, any data values (including URLs) must use entity escape codes for the characters listed in the following table. A sitemap can contain only ASCII characters; it can't contain extended ASCII characters or certain control codes or special characters such as * and {}. If your sitemap URL contains these characters, you'll receive an error when you try to add it. + +OnTrack-deploy Analysis +Current State: + +Readme file is Incomplete and needs updates. A lot of information is missing about the repository an API integration and functionalities. + +Almost all the sub directory’s markdown files are empty or lack proper readability. + +Contributing.md is complete and has great amount of information for individuals looking to contribute to doubtfire-deploy. + +Changelog.md is up to date and all of the functionalities are current and recent. However, the file is missing a header. + +Docker connection files are within the root of the repository. + +All the links are opening to external pages from the same window, limiting readability and flow. + +Quality assurance files are missing. + +Problem Statement +As a documentation team member, Our report will focus on a solution based on the analysis and we want to document everything on Doubtfire-deploy repository. + +There is incomplete documentation of the Doubtfire-deploy repository that is rising empty links within readme file, poor contributing.md formatting, empty markdown files within multiple sub-folders, missing header on CHANGELOG.md, missing Quality Assurance files and documentation links opening from within the same tab, limiting fluent readability. + +Proposed solution + +Producing a report that is efficient and effective on Doubtfire-deploy repository basing on the: + +Review and update readme.md file updating each link and exhaustively review every user guide within the file, keeping in mind the versions. +Review all the .md user manuals within each subdirectory, to ensure they are not just present, but contain meaningful information they are intended for. + +Improve the CHANGELOG.md file header and outlook. + +Add quality assurance files within the repository. + +Format all hyperlinks to load on a new tab. + +Scope +Analysis of OnTrack Deploy + +Definition of success +Implementation can be straight away and fix things to solve the problem immediately + +OnTrack-Web Analysis +Problem Statement +To analyse and record the current state of documentation in the Wodoubtfire-web repo from this report work we can make recommendations for documentation solutions. To create an overview of each repo (Wodoubtfire-web and doubtfire deploy) so I can understand what each file and folder does. + +There is incomplete documentation of the wodoubtfire-web repository that is arising from empty links within readme file, poor and in complete contributing.md file and its formatting, missing Quality Assurance files and documentation links opening from within the same tab, limiting fluent readability. + +Current state as per the analysis tabulated +Readme file is complete but needs a lot of updates and correction. It has a lot of valuable information about the + +MIGRAION_GUIDE.md is present and has valuable details for both upgrade and reverting. + +Contributing.md is incomplete and lacks great amount of information useful to developers willing to contribute to this repository. + +Changelog.md is present, complete correct and up to date but has a poor formatting and lacks a headers. + +Docker connection files are within the root of the repository. + +All the links are opening to external pages from the same window, limiting readability and flow. + +Quality assurance files are missing. + +Problem Statement +To analyse and record the current state of documentation in the Wodoubtfire-web repo from this report work we can make recommendations for documentation solutions. + +There is incomplete documentation of the wodoubtfire-web repository that is arising from empty links within readme file, poor and in complete contributing.md file and its formatting, missing Quality Assurance files and documentation links opening from within the same tab, limiting fluent readability. + +Proposed solution +The solution will ensure smooth recording details in the Analysis document in line with the existing template. The analysis is appropriately detailed so that a report can be produced and documentation solutions can be recommended. + +It will as well: + +Remove the Migration files and histories form the readme.md file and properly format the readme file. + +Review all the .md user manuals within each subdirectory, to ensure they aren’t just present, but contain meaningful information they are intended for. + +Improve the CHANGELOG.md file header and outlook. + +Add quality assurance files within the repository. + +Expectation +The analysis makes it quick and easy for the report to be produced + +Automatic production of Documentation and Recommendation using the template + +Ensuring template reuse by other schooler, researchers and UX experts + +Challenges +Time consuming analysing every single file in the repo + #### Project Members (6) _Delivery Representative:_ Shaine Christmas