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

Add configuration so that the “Documentation” is customizable on the top right corner on the homepage #267

Closed
Obarros opened this issue Jun 17, 2018 · 4 comments
Labels
enhancement New feature or request

Comments

@Obarros
Copy link
Contributor

Obarros commented Jun 17, 2018

Make the description that appears on the top right corner to be something else and not “Documentation” when desired.

As of now the value that is showed is not customizable at the moment.
We are getting the string from:

https://github.com/47deg/sbt-microsites/blob/c06973586873c4addab34d1af08f1eef95c3a6d8/src/main/scala/microsites/layouts/Layout.scala#L290

Not a big deal, but we can use the same configuration logic for it.
I can try to submit a PR for it if it's something that you would like to see:
Any help or suggestions are much appreciated.

@calvellido
Copy link
Contributor

Hi @Obarros, thanks for opening this, would be a a nice new feature indeed, PRs welcome of course! If not, I can try or have a look at it end of this week or next.

I guess the best path to follow would be to base the behaviour of this on the way micrositeDocumentationUrl param, or other microsite SBT settings works. And to not break old sites in case they update to a sbt-micrsosites version including this new feature, I would set 'Documentation' as the default value for this param.

You can find the keys being declared around here, the default values can set here, and also you should probably add some arbitraries on here.

If you start working on it and need further guidance don't hesitate to comment it on this issue, or in Gitter. Thanks!

@calvellido calvellido added the enhancement New feature or request label Jun 18, 2018
@Obarros Obarros changed the title Add configuration to so that the “Documentation” is customizable on the top right corner Add configuration so that the “Documentation” is customizable on the top right corner on the homepage Jun 18, 2018
@Obarros
Copy link
Contributor Author

Obarros commented Jun 18, 2018

@calvellido thanks for the great tips!
I will take a spin and try to submit a PR by following the guide you provide.
Take a look when you have time.

TODO:

  • Validate with a test case ?
  • Update docs?
  • Run, the Scalafmt configuration to ensure everything is formatted?

calvellido added a commit that referenced this issue Jun 19, 2018
@calvellido
Copy link
Contributor

@Obarros thank you very much for your contribution! Version 0.7.20 has been released including the feature to customize the Documentation label:

https://github.com/47deg/sbt-microsites/releases/tag/v0.7.20

@Obarros
Copy link
Contributor Author

Obarros commented Jun 19, 2018

@calvellido Thanks for your valuable support! ;)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants