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.

Sign up for GitHub

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

Jump to bottom

RE: #48: Rework documentation for file and repository naming #49

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

RE: #48: Rework documentation for file and repository naming #49

wants to merge 1 commit into from

Conversation

da2ce7
Copy link
Contributor

@da2ce7 da2ce7 commented Oct 7, 2021 •
edited
Loading

This quite a large rework.

There is now three documents:

  1. Naming_Codes.md
    This document lists the codes that are used for the filename.

  2. Filename_Structure.md
    This document details the encoding of the codes into the filename. With many examples.

  3. Repository_Structures.md
    This document details the folder structure of the Art Repository.
    (This document needs to be expanded upon in future commits.)

@da2ce7 da2ce7 added the epic label Oct 7, 2021
@da2ce7 da2ce7 added this to the REL03 milestone Oct 7, 2021
@da2ce7 da2ce7 requested a review from josecelano October 7, 2021 16:21
@da2ce7 da2ce7 linked an issue Oct 7, 2021 that may be closed by this pull request
Specification for File Naming Codes and File Repository Structure #48
Open
@da2ce7 da2ce7 force-pushed the issue-48-file-names branch 2 times, most recently from 01fd368 to 502cf26 Compare October 7, 2021 16:26
@josecelano josecelano mentioned this pull request Oct 7, 2021
Open
@da2ce7 da2ce7 added documentation Improvements or additions to documentation and removed epic labels Oct 7, 2021
@da2ce7 da2ce7 removed a link to an issue Oct 7, 2021
Specification for File Naming Codes and File Repository Structure #48
Open
josecelano
josecelano approved these changes Oct 8, 2021
View reviewed changes
documentation/Naming_Codes.md Show resolved Hide resolved
documentation/Repository_Structures.md Show resolved Hide resolved
documentation/Naming_Codes.md Outdated Show resolved Hide resolved
documentation/Naming_Codes.md Show resolved Hide resolved
@josecelano josecelano linked an issue Oct 8, 2021 that may be closed by this pull request
Specification for File Naming Codes and File Repository Structure #48
Open
@da2ce7
Rework documentation of the file and repository naming scheme
18bf90b 
This quite a large rework.

There is now three documents:

1. Naming_Codes.md
This document lists the codes that are used for the filename.

2. Filename_Structure.md
This document details the encoding of the codes into the filename. With many examples.

3. Repository_Structures.md
This document details the folder structure of the Art Repository.
(This document needs to be expanded upon in future commits.)
@josecelano josecelano marked this pull request as ready for review December 8, 2021 13:23
@josecelano josecelano mentioned this pull request Dec 8, 2021
Closed
4 tasks
@josecelano
Copy link
Member

hi @da2ce7,

I think Naming_Codes.md file does not make sense anymore since we now have the Nautilus Filename Specification.

Regarding Filename_Structure.md, do you want to put it on the Nautilus Filename Specification repo too?

And what about Repository_Structures.md?

@da2ce7
Copy link
Contributor Author

da2ce7 commented Dec 8, 2021

hi @da2ce7,

I think Naming_Codes.md file does not make sense anymore since we now have the Nautilus Filename Specification.

Regarding Filename_Structure.md, do you want to put it on the Nautilus Filename Specification repo too?

The Filename Structure can go into the Nautilus Filename Specification.

And what about Repository_Structures.md?

I think that the Repository Structures one is more suited to go to the librarian repo.

@josecelano
Copy link
Member

hi @da2ce7,
I think Naming_Codes.md file does not make sense anymore since we now have the Nautilus Filename Specification.
Regarding Filename_Structure.md, do you want to put it on the Nautilus Filename Specification repo too?

The Filename Structure can go into the Nautilus Filename Specification.

And what about Repository_Structures.md?

I think that the Repository Structures one is more suited to go to the librarian repo.

OK. I'm assuming that repo will only contain the Specification and we have to implement it in the Librarian, was that your idea?
Or maybe you also want to implement some functionalities like for example validation, and then import the package into the Librarian?. Depending on the approach we choose that can affect the implementation of this Librarian issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@josecelano josecelano josecelano approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
REL03
Development

Successfully merging this pull request may close these issues.

Specification for File Naming Codes and File Repository Structure
2 participants
@da2ce7 @josecelano