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.

Sign up for GitHub

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

Jump to bottom

(PR) Updated The Documentation #372

Merged
merged 19 commits into from
Sep 30, 2024
Merged

(PR) Updated The Documentation #372

merged 19 commits into from
Sep 30, 2024

Conversation

TebogoYungMercykay
Copy link
Contributor

Files Updated

  • Architectural Specification
  • Technical installation
  • Delivery Specification
  • Coding Standards

@TebogoYungMercykay TebogoYungMercykay added scope: Documentation Improvements or additions to documentation priority: High labels Sep 30, 2024
@TebogoYungMercykay TebogoYungMercykay added this to the Demo 4 milestone Sep 30, 2024
@vercel Vercel
Copy link

vercel bot commented Sep 30, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
the-republic ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 30, 2024 8:45pm

@MulisaMusehane
Update TestingSpecificationVersion4.md
003a586 
I've made the following changes to the testing specification as per your request:

Removed mentions of pgTAP and database testing.
Added Cypress for end-to-end testing.
Changed branch names from "dev" and "master" to "develop" and "main" respectively.
Removed the section on password resetting.
@MulisaMusehane
Copy link
Contributor

@ShamaKamina looks good, nice

@ShamaKamina
Copy link
Contributor

@MulisaMusehane Did you add the use case diagrams on the Requirement spec pdf? I dont see them on my side and I am not sure whther its a problem on my side only

@ShamaKamina ShamaKamina self-requested a review September 30, 2024 20:14
@TebogoYungMercykay
Copy link
Contributor Author

@TebogoYungMercykay I updated the links and added the testing specification here https://github.com/COS301-SE-2024/The-Republic/pull/372/commits/003a58634d2967f266c2fc220d3b9605bd235567

There is only one link that will not work which is the PDF to the UserManualVersion4.pdf - can you pls use the extension you used to get the .md of it to pdf bc there are links to images and if I gotta use latex for it, it'll take a while...

I have added the PDFs just now, Double check and yeah

@TebogoYungMercykay
Copy link
Contributor Author

Damn, Closed PR by Mistake...

gustavo

@ShamaKamina
Copy link
Contributor

@TebogoYungMercykay I updated the links and added the testing specification here https://github.com/COS301-SE-2024/The-Republic/pull/372/commits/003a58634d2967f266c2fc220d3b9605bd235567
There is only one link that will not work which is the PDF to the UserManualVersion4.pdf - can you pls use the extension you used to get the .md of it to pdf bc there are links to images and if I gotta use latex for it, it'll take a while...

I have added the PDFs just now, Double check and yeah

Eh you made changes? I already did everything

@MulisaMusehane
Copy link
Contributor

@TebogoYungMercykay I updated the links and added the testing specification here https://github.com/COS301-SE-2024/The-Republic/pull/372/commits/003a58634d2967f266c2fc220d3b9605bd235567
There is only one link that will not work which is the PDF to the UserManualVersion4.pdf - can you pls use the extension you used to get the .md of it to pdf bc there are links to images and if I gotta use latex for it, it'll take a while...

I have added the PDFs just now, Double check and yeah

Eh you made changes? I already did everything

He made updates on the .md. The PDF you used was the old one... he had to convert the new updated user manual that has pictures to PDF bc the one we initially used, which you refed earlier when fixing does not have pictures :)

@ShamaKamina
Copy link
Contributor

@TebogoYungMercykay I updated the links and added the testing specification here https://github.com/COS301-SE-2024/The-Republic/pull/372/commits/003a58634d2967f266c2fc220d3b9605bd235567
There is only one link that will not work which is the PDF to the UserManualVersion4.pdf - can you pls use the extension you used to get the .md of it to pdf bc there are links to images and if I gotta use latex for it, it'll take a while...

I have added the PDFs just now, Double check and yeah

Eh you made changes? I already did everything

He made updates on the .md. The PDF you used was the old one... he had to convert the new updated user manual that has pictures to PDF bc the one we initially used, which you refed earlier when fixing does not have pictures :)

Yes i made those changes already

@ShamaKamina
Copy link
Contributor

please check the logs of this pr homies

@TebogoYungMercykay
Copy link
Contributor Author

@ShamaKamina, are you saying that you added the PDFs on your side as well? In that case, we could use the ones you added. I just read the responses and thought no one added them since they didn't show in the code.

@ShamaKamina
Copy link
Contributor

@ShamaKamina, are you saying that you added the PDFs on your side as well? In that case, we could use the ones you added. I just read the responses and thought no one added them since they didn't show in the code.

yes i already added the pdfs with images for the requirement spec and the user manual

@MulisaMusehane
Copy link
Contributor

@TebogoYungMercykay I updated the links and added the testing specification here https://github.com/COS301-SE-2024/The-Republic/pull/372/commits/003a58634d2967f266c2fc220d3b9605bd235567
There is only one link that will not work which is the PDF to the UserManualVersion4.pdf - can you pls use the extension you used to get the .md of it to pdf bc there are links to images and if I gotta use latex for it, it'll take a while...

I have added the PDFs just now, Double check and yeah

Eh you made changes? I already did everything

He made updates on the .md. The PDF you used was the old one... he had to convert the new updated user manual that has pictures to PDF bc the one we initially used, which you refed earlier when fixing does not have pictures :)

Yes i made those changes already

@TebogoYungMercykay I updated the links and added the testing specification here https://github.com/COS301-SE-2024/The-Republic/pull/372/commits/003a58634d2967f266c2fc220d3b9605bd235567
There is only one link that will not work which is the PDF to the UserManualVersion4.pdf - can you pls use the extension you used to get the .md of it to pdf bc there are links to images and if I gotta use latex for it, it'll take a while...

I have added the PDFs just now, Double check and yeah

Eh you made changes? I already did everything

He made updates on the .md. The PDF you used was the old one... he had to convert the new updated user manual that has pictures to PDF bc the one we initially used, which you refed earlier when fixing does not have pictures :)

Yes i made those changes already

Alright cool

@ShamaKamina
Copy link
Contributor

sigh

image

@TebogoYungMercykay
Copy link
Contributor Author

TebogoYungMercykay commented Sep 30, 2024 •
edited
Loading

@ShamaKamina I see. And the changes you made were overwritten by this commit, After this, the User Manual without the images became the latest change.

@ShamaKamina
Copy link
Contributor

@ShamaKamina I see. And the changes you made were overwritten by this commit, After this, the User Manual without the images became the latest change.

Alright. You can fix whatever needs to be fixed

@TebogoYungMercykay
Copy link
Contributor Author

TebogoYungMercykay commented Sep 30, 2024 •
edited
Loading

@ShamaKamina I see. And the changes you made were overwritten by this commit, After this, the User Manual without the images became the latest change.

Alright. You can fix whatever needs to be fixed

I think everything is linked properly. Just double check on your side as well.

@ShamaKamina ShamaKamina merged commit 465984b into develop Sep 30, 2024
16 checks passed
@MulisaMusehane MulisaMusehane deleted the feature/update_docs branch October 1, 2024 05:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ShamaKamina ShamaKamina ShamaKamina approved these changes

@IRIA7 IRIA7 Awaiting requested review from IRIA7

@MulisaMusehane MulisaMusehane Awaiting requested review from MulisaMusehane

@hlokomani hlokomani Awaiting requested review from hlokomani

Assignees
No one assigned
Labels
priority: High scope: Documentation Improvements or additions to documentation
Projects
None yet
Milestone
Demo 4
Development

Successfully merging this pull request may close these issues.
4 participants
@TebogoYungMercykay @MulisaMusehane @hlokomani @ShamaKamina