Create Documentation / FAQ

[pascalchevrel]

An online Faq into the tool and maybe a couple of tutorials could be useful for users

[sekanderb]

Hello @pascalchevrel, I'd like to do the documentation and FAQ for this project. Can you please provide me a list of things need to be done? Like the topic list that needs to be covered?

[pascalchevrel]

Hi @badsha-eee and thanks for your help! :) I am on business travel now (writing this from an airport), how about getting back in contact next week when I am back tpo talk about it?

[sekanderb]

Sure! Have a safe journey :D

[enderandpeter]

Hey everyone. I'm hoping to help out Mozilla the best I can. I've been looking at this project and I greatly appreciate the Wiki. I do have some questions and comments about its setup.

1. In start..sh line 53, it says wait ./app/scripts/dev-setup.sh. This command gives the error ./start.sh: line 53: wait: './app/scripts/dev-setup.sh': not a pid or valid job spec. From what I am seeing online, the wait command expects only either a pid or job ID. Is this line a mistake, or is there a version of bash that allows this syntax?
2. This project ignores composer.lock. It is important to commit composer.lock to version control because that file locks the version of the dependencies to versions that you know will work. When composer install is ran without that file, it will download the latest versions specified in the composer.json that may not provide the same results as the versions in known stable environments.

I'm going to see if it can run the dev-setup.sh and get the Mozilla projects downloaded and I'll report any oddities. Thanks!

Update

I was able to get this site running. I can confirm that the "Full Installation" instructions in the readme are quite excellent. I also setup a Docker deployment that I will share once I get everything tidied up. This looks like a fun project. Hope I can help.

[flodolo]

For your point 1, that seems like an error introduced (by me) in a larger change.

For point 2, that's probably a good change to make. Happy to take a PR for it ;-)

[flodolo]

BTW, I've filed a new issue (#1031).

I haven't looked into it besides narrowing down how to reproduce it, so it might be harder than expected to fix. I'll leave it around for a bit in case you want to take a look.

[enderandpeter]

Thank you so much! Yes, I will make a PR for tracking composer.lock. I do appreciate it. I might make a separate one about removing the wait command for the time being, although I do believe the dev-setup.sh does still need to run there... but I'll double-check that.

Yes, I'll see what I can find out about #1031. With luck I might at least provide useful info. Thanks again!

[enderandpeter]

Check out this Docker setup I made for Transvision! It could be the basis for a succinct image, but working with these files is a very good time, in my experience. Just need to add https support and it will be very suitable for production deployment. Please give it a try for local development at the very least.