add changelog v1.0.0

[DeleMike]

Contributor checklist

• This pull request is on a separate branch and not the main branch
• I have ran the ./pre-commit executable as well as make lint and have fixed all reported issues

---

Description

Added first draft for CHANGELOG.md.

Related issue

• closes Write Scribe-Server changelog and release v1.0.0 #53

[github-actions]

Thank you for the pull request! 💙🩵

The Scribe-Server team will do our best to address your contribution as soon as we can. The following are some important points:

• Those interested in developing their skills and expanding their role in the community should read the mentorship and growth section of the contribution guide
• If you're not already a member of our public Matrix community, please consider joining!
  • We'd suggest that you use the Element client as well as Element X for a mobile app
  • Join the General and Data rooms once you're in
• Also consider attending our bi-weekly Saturday developer syncs!
  • Details are shared in the General room on Matrix each Wednesday before the sync
  • It would be great to meet you 😊

Note

Scribe uses Conventional Comments in reviews to make sure that communication is as clear as possible.

[github-actions]

Maintainer Checklist

The following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :)

• Tests for changes have been written and the continuous integration (CI) workflows within the PR checks do not indicate new errors in the files changed

• The CHANGELOG has been updated with a description of the changes for the upcoming release and the corresponding issue (if necessary)

[DeleMike]

Hi @andrewtavis, @axif0: I have added an initial draft for the changelog. What do you think?

[andrewtavis]

praise: This is looking so amazing, @DeleMike! 🤩 I just sent along minor changes and the same changes to the workflows that I sent to #68.

One note: The docs endpoint that's listed isn't working?

• https://scribe-server.toolforge.org/docs/index.html results in a blank page

[DeleMike]

I will look into that and send a fix here. Thanks for noticing ✨

[andrewtavis]

Thanks for checking it out, @DeleMike! Happy to merge this in once we figure it out 😊

[DeleMike]

Hi @andrewtavis, the issue is that https://scribe-server.toolforge.org/swagger/index.html works and https://scribe-server.toolforge.org/docs/index.html does not. And it is because /swagger and /docs were sharing the same swaggerFiles.Handler instance, and gin-swagger overwrites that handler's internal prefix based on whichever route hits it most recently. I changed to:

- r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
+ r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.NewHandler()))
- r.GET("/docs/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
+ r.GET("/docs/*any", ginSwagger.WrapHandler(swaggerFiles.NewHandler()))

I really hope this works when it is pushed to Toolforge. Because on localhost, but were working with the former code.

If it does not, then we should stick to https://scribe-server.toolforge.org/swagger/index.html while we find out what exactly the problem is.

[andrewtavis]

praise: Thanks for this, @DeleMike! Let's give this a go for the docs endpoint :)

[DeleMike]

Hi @andrewtavis , the addition fixed the issue. The docs link now works.

see link here: https://scribe-server.toolforge.org/docs/index.html

[andrewtavis]

Amazing, @DeleMike! Thanks for the solution and the heads up :)