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

Rename "doc" folder to "docs" #18

Open
koppor opened this issue Aug 19, 2019 · 3 comments
Open

Rename "doc" folder to "docs" #18

koppor opened this issue Aug 19, 2019 · 3 comments

Comments

@koppor
Copy link
Contributor

koppor commented Aug 19, 2019

I would propose to rename doc to docs (at least in this repository) to enable rendering of the docs using gh-pages (see https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages) and to be consistent to other GitHub repositories.

I know that adr-tools rejected that proposal: npryce/adr-tools#39 - maybe, you can spend a thought regarding that, too.

@adoble
Copy link
Owner

adoble commented Aug 24, 2019

  • The reason for the rejection was that it was not backward compatible. This doesn’t apply to adr-j as the directories used for the ADRs is stored in the adr.properties file (docPath). This means that users do not have to do anything with previously initialized projects.

  • I used doc originally to preserve the behavior of the original ADR tool. I think we have come a long way since then and this is no longer a requirement.

  • Have a config command #13 could mean that if users really wanted to change from doc to docs in an existing project they could do so. Note, the config command is more complicated than I first thought as config changes imply making a lot of changes to existing projects. Not impossible, it's just that I have not got around to it.

  • I would prefer that we use in this repository the default. Changing to docs means a bit of fiddling around (a test for the config command?).

  • As we are now using semantic versioning , have to consider if this change is an "incompatible API change" . In which case I would prefer to wait until we have accrued enough changes (e.g. Prefix environment variables with ADR_ #4, Have a config command #13 plus anything else that's wanted) to justify a 4.0.0 release. What do you think?

In short, I'm sympathetic to the idea, just need consider the above.

@adoble
Copy link
Owner

adoble commented Jan 11, 2024

@adoble
Copy link
Owner

adoble commented Sep 1, 2024

This issue has been open for a long time now. Personally, I still think it is a good idea, but as it is a change to the user facing API I'm still deferring it until we get to version 4 which is a major effort requiring changes to how adr-j fundamentally works.

As such I'm still leaving it open..

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