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.

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

Chapter on projects #22

Open
mbakeranalecta opened this issue Aug 5, 2014 · 3 comments
Open

Chapter on projects #22

mbakeranalecta opened this issue Aug 5, 2014 · 3 comments

Comments

@mbakeranalecta
Copy link
Contributor

There is currently no chapter on projects. They are mentioned in a few places:

  • In a couple of topics on configuration settings
  • In the chapter on editing XML documents at http://www.oxygenxml.com/doc/ug-editor/#topics/grouping-documents-xml-projects.html. This topic mentions in passing that projects can be shared between team members.
  • In topics on validation scenarios
  • In topics on transformation scenarios
  • In a topic on sharing projects with SVN, which I suspect is not referring to project files at all, but could be quite confusing to the reader who does a docs search for "project".

But there is no chapter about projects. I think there should be. Projects are an important part of Oxygen, and a lot of its functionality works through the project. Users would benefit from guidance on making the best use of projects, especially across teams.

@raducoravu
Copy link
Contributor

So somehow your idea would be to move the "grouping-documents-xml-projects.dita" on a higher level of the main dita map as a chapter? And maybe add more subtopics to it?

@mbakeranalecta
Copy link
Contributor Author

Something like that, yes. As a user myself, I don't think I am fully exploiting the capability of projects. I think more focused documentation could help people get more out of them.

@raducoravu
Copy link
Contributor

I agree. The project functionality should be better promoted and explained.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants