Can we simplify the Openverse Make site handbook and defer to the documentation site almost exclusively? #1241
-
I doubt we can get rid of the Make handbook entirely (though perhaps @zackkrida could find out for us), but needing to maintain two separate locations of documentation, and remember what is where (there's so much catalog documentation on the handbook, but all of that would be awesome to have in the documentation site), doesn't feel like a good long-term solution. It is not desirable to move all our documentation into the make site. Make is harder for us to iterate on. Can we move nearly all the documentation out of Make and into the documentation site instead? |
Beta Was this translation helpful? Give feedback.
Replies: 2 comments
-
There is a lot of content is the Make handbook that's oriented towards developers. That definitely should be moved to the docs site. However the Make handbook contains some pages like "History of Openverse" and "2022 Roadmap" that seem like a better fit for the handbook, considering that these pages mostly for people outside (and above) the team and the content in them is either static, or doesn't change very often. Maybe we can keep both and define rules for what type of documentation goes where. I see pages that pertain to a somewhat political nature being a better fit for the Make handbook. |
Beta Was this translation helpful? Give feedback.
-
Yes, absolutely! This was discussed by my cohort during the docs bash, I proposed it there, and we all gave it a 👍. Here's the line from the spreadsheet: https://docs.google.com/spreadsheets/d/1AW5LAzzqRhG_oRKFojCe4frV7ASdDTtVdQHhkbpVDQU/edit#gid=0&range=20:20 The specific tasks I outlined there were:
For SEO reasons it makes sense to move some non-technical Openverse backstory into openverse.org itself. |
Beta Was this translation helpful? Give feedback.
Yes, absolutely! This was discussed by my cohort during the docs bash, I proposed it there, and we all gave it a 👍. Here's the line from the spreadsheet: https://docs.google.com/spreadsheets/d/1AW5LAzzqRhG_oRKFojCe4frV7ASdDTtVdQHhkbpVDQU/edit#gid=0&range=20:20
The specific tasks I outlined there were: