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

Docs directory prune: iris/docs/iris -> iris/docs/ #3836

Closed
tkknight opened this issue Sep 10, 2020 · 2 comments · Fixed by #3975
Closed

Docs directory prune: iris/docs/iris -> iris/docs/ #3836

tkknight opened this issue Sep 10, 2020 · 2 comments · Fixed by #3975
Assignees
Labels
Peloton 🚴‍♂️ Target a breakaway issue to be caught and closed by the peloton Type: Documentation Type: Infrastructure
Milestone

Comments

@tkknight
Copy link
Contributor

📚 Documentation

This is not about the contents of the documentation, instead it is about having a more sensible directory structure. The docs currently live in iris/docs/iris. There seems no reason to have iris in the path twice so I propose moving the docs to iris/docs.

There may be several locations where this path needs to be updated (docs, Makefile, image testing repo etc).

Suggest this is done after the Iris 3.0.0 release to avoid impacting any outstanding docs related changes for now.

There is another issue (#3416) about moving directories, in this case for the test directory - not related to the documentation though.

@trexfeathers
Copy link
Contributor

I'm not clued up on the docs side of things, but the existing directory structure is the favoured convention for source code (iris/lib/iris) - see SciTools-incubator/iris-ugrid#4 (comment). I assume there is either a similar argument for the docs, or maybe it was only done for consistency. It's a difficult thing to phrase as a web search!

@tkknight
Copy link
Contributor Author

From some initial investigation my docs directory proposal seems to fit with the community approach.

@tkknight tkknight self-assigned this Sep 22, 2020
@tkknight tkknight added this to the v3.1.0 milestone Sep 22, 2020
@bjlittle bjlittle added Peloton 🚴‍♂️ Target a breakaway issue to be caught and closed by the peloton and removed New: Documentation labels Oct 1, 2020
@bjlittle bjlittle added this to Backlog in Iris v3.1.0 via automation Oct 1, 2020
@bjlittle bjlittle added this to To do in Peloton Oct 1, 2020
Iris v3.1.0 automation moved this from Backlog to Done Feb 3, 2021
Documentation automation moved this from To do to Done Feb 3, 2021
Peloton automation moved this from To do to Done Feb 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Peloton 🚴‍♂️ Target a breakaway issue to be caught and closed by the peloton Type: Documentation Type: Infrastructure
Projects
Documentation
  
Done
Iris v3.1.0
  
Done
3 participants