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

docs(build): add text build steps for Linux, Mac and Windows #1963

Closed
AbhinavMir opened this issue Apr 10, 2022 · 5 comments · Fixed by #3421
Closed

docs(build): add text build steps for Linux, Mac and Windows #1963

AbhinavMir opened this issue Apr 10, 2022 · 5 comments · Fixed by #3421
Assignees
@ashnashahgrover
Labels
Developer_Experience documentation Improvements or additions to documentation enhancement New feature or request

Comments

@AbhinavMir
Copy link

The current build instructions use YouTube videos to display how to build Cactus locally. While this is great in general, but people with accessibility issues might run into problems. The videos are divided and text is small, someone with slower internet or bad eyesight for example wouldn't be able to access this. Due to lack of sound, this is completely inaccessible to the visually impaired.

I propose an Iroha-like documentation in addition to current documentation.

If assigned, I'm happy to make these changes ASAP. Open to views.
@AbhinavMir AbhinavMir added the enhancement New feature or request label Apr 10, 2022
@petermetz
Copy link
Contributor

@AbhinavMir Very much agreed and thank you so much for bringing this up! Assigning now and thank you in advance for all your contributions!

@petermetz petermetz added documentation Improvements or additions to documentation Developer_Experience labels Apr 13, 2022
@petermetz petermetz changed the title Add text build instructions for Linux, Mac and Windows in addition to current build instruction docs(build): Add text build steps for Linux, Mac and Windows Apr 13, 2022
@petermetz
Copy link
Contributor

@AbhinavMir Please also note that I slightly refactored the issue title which now you can copy paste into your future commit message that you'll make the changes in (we have a commit message linter so that's why this is more important than it looks at first sight)

@petermetz petermetz changed the title docs(build): Add text build steps for Linux, Mac and Windows docs(build): add text build steps for Linux, Mac and Windows Apr 13, 2022
@AbhinavMir AbhinavMir mentioned this issue Jun 10, 2022
Closed
@ashnashahgrover
Copy link
Contributor

Please assign me

@jagpreetsinghsasan
Copy link
Contributor

@petermetz we have assigned @ashnashahgrover for covering specifics of Cacti setup for MacOS.
Once done, we will have someone to update it for Ubuntu 22.04

@petermetz
Copy link
Contributor

@jagpreetsinghsasan Nice, thank you! @ashnashahgrover Good luck and thank you as well!

ashnashahgrover added a commit to ashnashahgrover/cacti that referenced this issue Jul 18, 2024
@ashnashahgrover
docs(build): add text build steps for Linux, Mac
8697f36 
and Windows

Primary Changes
----------------
1. Updated BUILD.md to include Mac OS specific
installation instructions.

Fixes hyperledger-cacti#1963

Signed-off-by: ashnashahgrover <as19@williams.edu>
@ashnashahgrover ashnashahgrover mentioned this issue Jul 18, 2024
Merged
5 tasks
ashnashahgrover added a commit to ashnashahgrover/cacti that referenced this issue Jul 18, 2024
@ashnashahgrover
docs(build): add text build steps for Linux, Mac and Windows
d7552ac 
Primary Changes
----------------
1. Updated BUILD.md to include Mac OS specific installation instructions.

Fixes hyperledger-cacti#1963

Signed-off-by: ashnashahgrover <as19@williams.edu>
ashnashahgrover added a commit to ashnashahgrover/cacti that referenced this issue Jul 22, 2024
@ashnashahgrover
docs(build): add text build steps for Mac
f33dbf8 
Primary Changes
----------------
1. Updated BUILD.md to include Mac OS specific installation instruction
2. Added placeholders for Linux and Windows specific instructions.
 
Fixes hyperledger-cacti#1963

Signed-off-by: ashnashahgrover <as19@williams.edu>
ashnashahgrover added a commit to ashnashahgrover/cacti that referenced this issue Jul 22, 2024
@ashnashahgrover
docs(build): add text build steps for Mac
b8da32d 
Primary Changes
----------------
1. Updated BUILD.md to include Mac OS specific installation instruction
2. Added placeholders for Linux and Windows specific instructions.
 
Fixes hyperledger-cacti#1963

Signed-off-by: ashnashahgrover <as19@williams.edu>
petermetz pushed a commit to ashnashahgrover/cacti that referenced this issue Jul 31, 2024
@ashnashahgrover @petermetz
docs(build): add text build steps for Mac
679dd2e 
Primary Changes
----------------
1. Updated BUILD.md to include Mac OS specific installation instruction
2. Added placeholders for Linux and Windows specific instructions.
 
Fixes hyperledger-cacti#1963

Signed-off-by: ashnashahgrover <as19@williams.edu>
petermetz pushed a commit that referenced this issue Jul 31, 2024
@ashnashahgrover @petermetz
docs(build): add text build steps for Mac
7621db7 
Primary Changes
----------------
1. Updated BUILD.md to include Mac OS specific installation instruction
2. Added placeholders for Linux and Windows specific instructions.
 
Fixes #1963

Signed-off-by: ashnashahgrover <as19@williams.edu>
@github-project-automation github-project-automation bot moved this from In review to Done in Cacti_Scrum_Project_v2_Release Jul 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ashnashahgrover ashnashahgrover

Labels
Developer_Experience documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs(build): add text build steps for Mac ashnashahgrover/cacti
4 participants
@petermetz @AbhinavMir @ashnashahgrover @jagpreetsinghsasan