Comments (10)
IMHO this is one of those occasions in which a human synthesizing the information contained in the closed issue is required. Otherwise that book would be equivalent to a search among the issues of this repository.
from questions-and-answers.
https://www.gitbook.com/book/roboticslab-uc3m/qa
from questions-and-answers.
Among this line, a script to port closed issues (not invalid) to .md
sounds feasible. Would it be worth the effort?
from questions-and-answers.
Otherwise that book would be equivalent to a search among the issues of this repository.
Which is one of the reasons I have also been doubting if this issue should be labeled invalid
. :-)
Let's turn this into a question!
Is human synthesizing the information contained in the closed issues of this repository worth the effort?
from questions-and-answers.
In my opinion, doubts are usually due to some misleading or missing documentation and, when they happen, docs should be fixed. It is also important to make these fixes visible instead of buring them in a repository.
Doubts may arise from very different repositories and contexts, and this a quite generic place to store them all. Therefore I think that users and developers will benefit if the results of each closed issue is documented at the place or context that generated that particular doubt.
But this is my particular view, and I would like to read other opinions to know what do the rest of the team think about this and their ideas.
from questions-and-answers.
Have you ever considered using the Wiki tab (between Projects and Insights)? It could be a good place to collect repo-related stuff regarding recurrent issues and their solutions, FAQs, guides, etc.
from questions-and-answers.
@David-Estevez Agreed that issues should be moved as close as possible to scope of repository, but still think there are general questions so this repo has a reason to be (in addition to a generic place for newbies).
@PeterBowman I like GitBook because it is synced with the repo. Wiki feels like a yet another repo (in fact has its own URL) and that really does start to feel like too many repos.
from questions-and-answers.
Almost distiguishing 3 types of issues in this repo (first and second are similar, but I wanted to distinguish them, because the first group could look like a motivation for a FAQ gitbook at first glance, but not on second thought):
- Questions that once answered should become part of https://github.com/roboticslab-uc3m/best-practices (examples: #29 , #14 ...) -> no reason for a FAQ gitbook.
- Questions that should become part of a different repository (mostly moved already). -> no reason for a FAQ gitbook.
- Tasks that are very horizontal to the organization, such as #2 (Major code reorganization among repositories). -> no reason for a FAQ gitbook.
In consequence, and thanks to your contributions, I am considering the answer is no
and closing this issue. Please reopen if you think elsewise!!!
from questions-and-answers.
Comment on small outliers:
- #28 (How can I program... by demonstration) could go in https://github.com/roboticslab-uc3m/teo-software-manual but maybe deserves a more generic software manual or tutorials repo.
- More outliers could be #27 but that could actually go upstream to yarp.
from questions-and-answers.
- Questions that once answered should become part of https://github.com/roboticslab-uc3m/best-practices (examples: #29 , #14 ...) -> no reason for a FAQ gitbook.
Update: best-practices is now https://github.com/roboticslab-uc3m/developer-manual so this makes even more sense.
from questions-and-answers.
Related Issues (20)
- YCM 0.10 upgrade path HOT 9
- Make dox target via YCM goodies HOT 9
- Unit tests and unsatisfied dependencies lead to compilation failure HOT 1
- Embrace hooks HOT 3
- Bump required YCM version (v0.10+) HOT 4
- YARP 3.0 upgrade path HOT 5
- Update CMake/YCM export options HOT 10
- [GitHub] Git LFS disabled for roboticslab-uc3m HOT 2
- Centralize Travis scripts HOT 4
- Changes to git branch policy in YARP/YCM HOT 8
- Drop dual master-develop branching in favor of a single prod branch HOT 10
- Review installation-related snippets in Markdown docs HOT 1
- Using YARP's internal logging instead of color-debug HOT 15
- Migrate to GitHub Actions HOT 24
- Add C++ examples to main build HOT 7
- Update links to GitBook project instances on legacy servers HOT 3
- Portmonitors renamed at YARP >= 3.5 HOT 1
- Update links pointing at new subdomain HOT 4
- sp_ineachdb and also sp_msforeachDB return only 50 records instead of hundreds HOT 3
- Randomization problems with JsPsych HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from questions-and-answers.