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

Repo Proposed Structure #2

Open
ManconiAlessandro opened this issue Oct 11, 2018 · 2 comments
Open

Repo Proposed Structure #2

ManconiAlessandro opened this issue Oct 11, 2018 · 2 comments

Comments

@ManconiAlessandro
Copy link

Root

  • Folders by macro-topic (development, data analysis, software engineering, conventions and etc)
    • The folders of specific topics will include:
      • Folder for "eBooks"
      • .md files with links to referred articles/documentation

.md files

Filename
"argument".md

FileContent

  • Link to the resource
    • Every link must be followed by a little description to give a bit of context to increase the QoL consulting the repo

eBooks

Preferred Extensions

  • ePub
  • Pdf
  • Mobi

Let's give some context
Every link must be followed by a little description to give a bit of context to increase the QoL consulting the repo

@ManconiAlessandro ManconiAlessandro changed the title Repo's Proposed Structure Repo Proposed Structure Oct 11, 2018
@poliez
Copy link
Owner

poliez commented Oct 11, 2018

Most of this, as i said earlier, makes sense 👍

I was also thinking that we could ad more specific folders under the main folder of each topic. Initially only eBooks could be sufficient, but we could think about other folders like "Articles" and "Discussions". I think that the resources could be categorized further down the path, always allowing more generic resources inside at any point below /resources.

@ManconiAlessandro
Copy link
Author

I've already considered including more folders, but i didn't mentioned it because i though it was too early.

Anyways, I would like to include indexing for both root and each macro-topic folder:

Root

Index will be available in the README.md file. It will contain links that will lead to each macro-topic (e.g. big-data, git, C++, etc)

Macro-Topic folder

Index will be available in a dedicated README.md file and the structure may look like this:

[Folder] Topic (Root)

  • [Folder] eBooks
    • [File] Filename
    • [File] Filename
  • [Folder] Articles
    • [File] Filename
    • [File] Filename
  • [Folder] Discussions
    • [File] Filename
    • [File] Filename
  • [File] filename
  • [File] filename

Files in the Root folder may come from more other sources, that could be integrated futher in the future

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

No branches or pull requests

2 participants