Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/installation updates and help #16

Merged
merged 61 commits into from
Mar 2, 2023

Conversation

Dane-2pi
Copy link
Contributor

@Dane-2pi Dane-2pi commented Mar 2, 2023

Starting the PR for Alice' changes

Taliesin Millhouse and others added 30 commits December 8, 2020 12:23
- Started the reports page, completed the setup section and added headings for writing and running reports
- Updated doc_menu.yml module items to be capitalised

refs: 8396
removing outService and ctxService functions in code examples

refs: 9879
Amending the code that renders the form

refs: 9879
fix: removing false service functions
Updates on requirements since we started using Docker containers for cmfive. A second way to clear the config cache added to the tute, and small grammatical edits.

refs: 10186
Specific install information for developers. Notes on what needs to go in that page.

refs: 10186
Added requirements needed since we stared using Docker

refs: 10186
Information on finding and setting the hostname in the config file for developers

refs: 10186
Removing comments on things to do that have been completed

refs: 10186
comments noting what needs to go in new pages

refs: 10186
Adding page on creating MySQL users and checking which user is logged in using the terminal

refs: 10186
Instructions for checking which user is being used by the server

refs: 10186
Putting help menu in more logical order

refs: 10186
Brief explanation of what timestamp at front of migrations is, and what it looks like

refs: 10186
Editing of grammar, punctuation and spelling based on suggestions from Grammarly

refs: 10186
Added page on code needed when writing insights in order for it to work correctly.

refs: 10167
Small fixes for spelling as per requests on GitHub

refs: 10167
Statement of where some installation issues and solutions are covered, and note that support cannot always be offered for issues installing and running cmfive on some operating systems.

refs: 10186
Notes on what needs to be added to this page and where

refs: 10186
Starting to add information to pages from notes. Used image of docker tab symbol to help clarify instructions.

refs: 10186
Adding information to the help page based on the notes

refs: 10186
Small edits for grammar fixes and improved clarity for the reader.

refs: 10186
Reordering instructions for error in instructions noted.

refs: 10186
Small edit and notes on what needs to be added to the install and migrations page

refs: 10186
Directs people to files in cmfive where more options can be found for the part of their module they are creating. That is cmfive settings that can be used and cmfive fixed columns that all tables will automatically have, and further precoded html elements that can be added in the template.

refs: 10186
Notes on pages to be added to the tutorial

refs: 10186
updating the installation instructions

refs: 10186
Some information on commands for checking the MySQL user and owner of the files

refs: 10186
beginning of instructions for creating a MySQL user

refs: 10186
Finish instructions on creating a MySQL user and granting them access and full privileges on the cmfive database

refs: 10186
Explanation of what the second bash command used on the mysql-users page is doing.

refs: 10186
Delete page files that have been decided unnecessary, not to be included, or have their information transferred to another page.

refs: 10186
fix broken link to installation page

refs: 10186
Editing to contain all information that has been edited or changed on this branch, and also all the information on 
feat: add documentation for setting up a cmfive local dev environment

refs: 10186
Changing format of installation instructions to a step-by -step guide.

refs: 10186
Changes to requirements document not finished. Notes added for anyone else to see what needs doing

refs: 10186
Brief explanation of what the tutorial shows you how to do and when you may or may not use the template.

refs: 10186
@Dane-2pi
Copy link
Contributor Author

Dane-2pi commented Mar 2, 2023

The conflict is going to need some work, Adam's one is more up to date, but Alice's is better written.
And neither takes codespaces into account, or any other changes over the last 12 months

@@ -2,7 +2,7 @@ name: CI

on:
push:
branches: [ master ]
branches: [ master, feature/spellcheck ]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

drop this again, but it should be on develop

@Dane-2pi
Copy link
Contributor Author

Dane-2pi commented Mar 2, 2023

The CI tools are back,
No deletions, all additions. I've been through every file to look for obvious errors, but not with a base install beside me.

Copy link

@2piJareem 2piJareem left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good Dane. Given that it is documentation I'm happy to approve.

@adam-buckley adam-buckley merged commit 8445f17 into master Mar 2, 2023
@adam-buckley adam-buckley deleted the feature/installationUpdatesAndHelp branch March 2, 2023 22:53
@Dane-2pi Dane-2pi linked an issue Mar 3, 2023 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Corrections to cmfive documentation required
5 participants