Documentation?

[AFWSI]

Are you guys gonna make any documentation since there’s now a “release”? I can’t figure out why half of my pictures fail and why the cameras are always lined up about a 30 degree angle from the ground. I’m sure tweaking some settings will prolly help with this ,but which ones on which node is the question. Some documentation on these settings would be nice.

[AdityaSrivastava2819]

Yeah, we can't use Meshroom to the fullest without some documentation or tutorials. Also, Alicevision should start using its YouTube channel more and more.

[ChemicalXandco]

I am willing to contribute to the documentation.

[AdityaSrivastava2819]

Me too, but I don't know how to use Meshroom.

…

On Sat, 1 Sep 2018 6:39 pm ChemicalXandco, ***@***.***> wrote: I am willing to contribute to the documentation. — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#186 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AkMXgvneawqRA8Qy_dVcoATin1hT6wyWks5uWob5gaJpZM4V6s6V> .

[fabiencastan]

Yes, we definitely need more documentation!
Currently the best source of information is still the video https://youtu.be/v_O6tYKQEBA.
To understand the 3D reconstruction concepts behind each node, you have a short description with references to publications here: https://alicevision.github.io/#photogrammetry

Thanks for the contribution proposition, that would be really useful.
We will publish a new tutorial soon that will provide an initial document that can be improved collaboratively.

[AdityaSrivastava2819]

That'll be great! You should post more and more tutorials on YouTube. That would attract people and then they will also make tutorials. Also, they would then be able to contribute to the documentation. YOUTUBE is a great place for such things. Just look at Blender's channel. They post a lot about development and there is an active community that makes more tutorials. You should also do livestreams and tell about the development. 1 video per week or 2 weeks would be great! Also, we need FORUMS for Meshroom. BLOGS are also great like those of Unreal, Unity, Blender, etc.

…

On Tue, 4 Sep 2018 9:31 pm Fabien Castan, ***@***.***> wrote: Yes, we definitely need more documentation! Currently the best source of information is still the video https://youtu.be/v_O6tYKQEBA. To understand the 3D reconstruction concepts behind each node, you have a short description with references to publications here: https://alicevision.github.io/#photogrammetry Thanks for the contribution proposition, that would be really useful. We will publish a new tutorial soon that will provide an initial document that can be improved collaboratively. — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#186 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AkMXgnGBZ4EC2BWCtYNsYs5KlGQB7Jpfks5uXqPygaJpZM4V6s6V> .

[fabiencastan]

Hi @AdityaSrivastava2819

Thanks for your message. As explained in #234, we are a small team and cannot manage to maintain all that. Creating videos, update blogs and forums takes a huge amount of time.
Contributions would be much appreciated to help us to focus on speedups and new features for the next release.
Best,

[ChemicalXandco]

@fabiencastan I am ok in python and would like to contribute to meshroom but the codebase is confusing to me, what would be the best way to get in touch with the devs so I can be familiar with it?

[fabiencastan]

@ChemicalXandco Oh cool, that would be great! @yann-lty is on vacation this week and he knows this part better than anyone else. So we can setup a conf call next week for a first meeting if it's good for you.

And then of course, we will see for slack or gitter for direct discussions.

[ChemicalXandco]

@fabiencastan don't waste your precious time on me, I'm only interested in the front-end and I can probably work out a lot of it anyway. Gitter is fine thanks.

[natowi]

I am working on a User Guide, collecting all the information from github issues, source code comments, blogs, tutorials and the Alicevision homepage. I´ve also created screenshots, wrote text and collected information from various papers.
Figuring out the node parameters is hard, but step by step I´m getting there.
At the moment I am at 44 pages (.odt doc.). I have to do some cleanup and add citations before I am ready to share it.
This might be a good base to start the documentation. Maybe it is easier for the AliceVision team to contribute details/content to an existing manual.

[simogasp]

@natowi That's simply great! Maybe you can share the document as a public googledoc so we can suggest correct and complete your document. You can share publicly and allow people only to suggest changes, rather than directly change the content.

[ubershy]

@natowi thank you for working on this. I really miss documentation.

[natowi]

I´ll share my documentation in the next days

[natowi]

Update: 95% done. Here is a short summary. It took me some time to bring all the information in order.
There´s still a lot of work to do, but at the end of the week we´ll have something to work with.

Summary
This manual starts with the Meshroom history and how to download, install or compile it for your platform.
New users should start with the First Steps: Meshroom chapter, which is a walk through the default pipeline using a demo dataset to prevent errors and get a good first result.
The next chapter Advanced Reconstruction is for Users, who want to use their own data.
At first, it contains some photo shooting advices (#17) for new users, followed by a list for suitable tethering software to optimize data collection.
The last part of the chapter describes different ways to add images to Meshroom and handle common problems.
The Background: Default Pipeline chapter contains detailed background information and descriptions for the default pipeline. It is highly recommended to read, as it contains useful insights.
If you want to customize the default pipelines settings, jump to the “Improve the default pipeline” chapter.
The chapter is followed by the Complete Node List with descriptions, tips and comments.
At last you will find tips on how to share or export models from Meshroom and import them in other software.
At the end there´s a list with related projects, the Meshroom licenses, contact details, ways to contribute, special thanks and a comprehensive references list.

// I included some chapters not specifically related to Meshroom, but I think they might be interesting for users, who are new to photogrammetry.
__
@johnhable is it okay to use and modify your helpful blogpost as part of the documentation?
@ryanfb is it okay to use and modify your Mac OSX help as part of the documentation?
@eprana can you share the Mikros document on shooting advices?
Big thanks in advance

[johnhable]

Hi @natowi. Sure, feel free to use any part of that blog post in your documentation.

[ryanfb]

@natowi - yes, feel free.

[serapth]

First off, awesome software, cool to see this open source. I agree full-heartedly about the need for documentation, I struggled to get a good result out of the box too.

In the end though, I did put together this step by step tutorial, that will at least get you up and started using an existing photo set, so people can at least get off on the right foot. Also did a few suggestions, from my own experience, on taking photos that will work, which is going to be a tripping point for many. I also did a much more in-depth 30 minutes with Meshroom video, that people will hopefully find useful.

Again, great work!

[natowi]

I am still working on the manual so there are some messy parts, but feel free to read and comment.
You are welcome to contribute.

[steren]

Thanks for the user guide. It's especially great that users can comment and suggest via Google Docs for fast iteration.

I think the main problem is that it is completely hidden. Even if it's not perfect, what do you think of publishing it online and keep iterating on its content via git commits? You could start pointing at it from the Meshroom homepage. This would help when looking for help in search engines.

Github pages can be a great way to easily publish static content from a git repository.
Or using the wiki associated with this repo could also work.

[natowi]

@steren Thank you for the feedback.

The idea was to add the manual content to the wiki and release a complete PDF. At the moment the wiki is used for FAQ.

Before pushing the manual to github, I would like to bring it in a presentable form. (Order, name and content of the chapters, formatting, images, references, phrasing,...)

I could use some help, so you are welcome to edit or comment the current manual.

[ultrasuperpingu]

The GoogleDoc document is a great start for people who don't have time to dig into the academic papers ;). Thanks a lot.

[natowi]

Due to increasing demand I´ll start migrating the documentation to Github soon.

[natowi]

Update: I am preparing the documentation for the Github release now, using reStructuredText and Sphinx.

[fabiencastan]

Hi @natowi,
Help on documentation would be awesome!
I'm not sure to understand what you're planning to do.
Could we setup a confcall to discuss about it?

[natowi]

Hi @fabiencastan,
to make contributions and access easier, I would like to move my google doc (after some restructuring and cleanup) to github.
I´ve sent you an email.

[natowi]

Here is the new home of the documentation. There is still a lot to do, but we are getting there. In the future we will be able to create the doc as pdf and html, readthedocs compatible.

[natowi]

Check out the latest Meshroom manual (PDF, HTML, EPUB)
Contributions are welcome.