Skip to content
This repository has been archived by the owner on Jan 2, 2019. It is now read-only.

Clean old & unuseful files #62

Closed
Progi1984 opened this issue Oct 19, 2012 · 16 comments
Closed

Clean old & unuseful files #62

Progi1984 opened this issue Oct 19, 2012 · 16 comments
Assignees
Milestone

Comments

@Progi1984
Copy link
Member

Some old files created by @maartenba could be deleted. No ?

phpdoc-home.ini 
phpdoc.ini
setpath.bat
start_shell.bat
Documentation/assets/*
Build/old/*

A file is duplicate

Diff between README.md and readme.md

And others which contains samples and tests for JAMA

Classes/PHPExcel/Shared/JAMA/examples
Classes/PHPExcel/Shared/JAMA/tests
@Progi1984
Copy link
Member Author

@MarkBaker Is it possible to not include help for JAMA ?

@ghost ghost assigned Progi1984 Oct 29, 2012
@maartenba
Copy link
Member

The old files can go, Documentation/assets may contain some that we want to keep (basically architectural schemas)

@Progi1984
Copy link
Member Author

@maartenba But with PHPDoc, normally, we have a class hierarchy (like that : http://demo.phpdoc.org/Responsive/graph_class.html) which can replace that ?

@maartenba
Copy link
Member

Indeed. In that case, I think it's safe to remove those files

@MarkBaker
Copy link
Member

The assets images appear in the documentation and are a lot easier to read because they show just the few relevant elements from the phpdoc mapping, in the context of the documentation. As such, I think they should remain.

@Progi1984
Copy link
Member Author

@MarkBaker : Are they uptodate ?

Progi1984 added a commit that referenced this issue Oct 30, 2012
Progi1984 added a commit that referenced this issue Oct 30, 2012
@MarkBaker
Copy link
Member

The ones I'm looking at are up to date, though they may not all be.... I'll check later. Most are simply xml files, or images created from those xml files.
It might be an idea to switch them to a different (more generic) format like GraphViz which would make them easier to edit.

@Progi1984
Copy link
Member Author

In the directory, we can include a phpdoc of PHPExcel correctly generated with graphviz (the render is perfect, i try it this morning)

OR

We can create a branch (or a repo) dedicated to the doc (including Users documentation and PHPDoc for developpers) which permit to answer in part to the bug GH-#1

@Progi1984
Copy link
Member Author

@MarkBaker In this zip (http://dl.free.fr/vqf8kX2if), there is the generation of PHPExcel's documentation with PHPDoc.

You can see the generated graphviz.

@Progi1984
Copy link
Member Author

@MarkBaker Another idea : I create GitHub Pages for managing pages for PHPExcel (GH #17) which create a branch gh-pages... and in a directory of this branch, we store a generation of PHPExcel documenation with PHPDoc...

This permits developers to see it online easily and solve in part the GH #1

@Progi1984
Copy link
Member Author

With commits f2803e8 and 9907ef9, @MarkBaker has cleaned JAMA.

@Progi1984
Copy link
Member Author

Could we move documentation in phpoffice.github.com repo ?

@Progi1984
Copy link
Member Author

@MarkBaker & @maartenba : What do you think about putting documentation in a dedicated branch, or a dedicated repo ? And why not in repo https://github.com/PHPOffice/phpoffice.github.com which manages http://phpoffice.github.com/ ?

@maartenba
Copy link
Member

Sounds good

@Progi1984
Copy link
Member Author

@maartenba for which one ? 😜

@maartenba
Copy link
Member

Both :-)

@Progi1984 Progi1984 added this to the 1.8.0 milestone Sep 10, 2014
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants