Skip to content

Adjust the logo link (was Contribution needs improving) #30

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

Closed
cartermp opened this issue Aug 1, 2020 · 4 comments
Closed

Adjust the logo link (was Contribution needs improving) #30

cartermp opened this issue Aug 1, 2020 · 4 comments

Comments

@cartermp
Copy link
Member

cartermp commented Aug 1, 2020

It is now unclear how I can materially improve the generated documentation site.

  • If I want to change what clicking on the F# logo does, where do I contribute that code?
  • If I want to change how search looks, where do I contribute? What if I want to specialize it a little bit beyond what the generic template offers?

The current stated contribution is now heavy enough that only Microsoft employees and F# compiler contributors will actually help with anything:

  • Clone dotnet/fsharp and ensure you have the right branch
  • Clone this repo somewhere else
  • Run some commands

The fact that people need to clone two repos just to contribute something will put off other contributors.

@dsyme
Copy link
Contributor

dsyme commented Aug 1, 2020

Yup, agreed

@dsyme
Copy link
Contributor

dsyme commented Aug 1, 2020

I've added information on three different kinds of contribution (content, auto-generation and design/layout) to #35

If I want to change what clicking on the F# logo does, where do I contribute that code?

As explained now in the README after #35

  1. This repo is currently using the default template, which uses {{root}} as the default link on that logo.

  2. The value for {{root}} comes from here, i.e. in a normal project it is the same as the website link for the nuget packages being built which is the same os the host site for the documentation.

  3. That's normally a reasonable default, because the technology and docs are usually at the website for the technology. FSharp.Core is a bit weird in this regard.

So to change this we need to either copy and modify the default template, or contribute back a change to FSharp.Formatting to optionally use a different substitution, e.g. {{logo-link}} which is by default set to {{root}}. To do this

  1. Add a new line "logo-link", packageProjectUrl here

  2. Adjust the default template here

  3. Here the fsdocs build invocation should pass --parameters logo-link https://fsharp.org

@dsyme dsyme changed the title Contribution needs improving Adjust the logo link (was Contribution needs improving) Aug 1, 2020
@dsyme
Copy link
Contributor

dsyme commented Aug 1, 2020

If I want to change how search looks, where do I contribute? What if I want to specialize it a little bit beyond what the generic template offers?

I've added instructions about what to do to fiddle with the template and styling. Start by copying over fsdocs-style.css or all of _template.html and all of the styling into the docs directory and then fiddling.

I'd like to make it a joint goal to get the default template(s) of FSharp.Formatting to be good enough for this site. This means whatever improvements you make should eventually get copied across back into FSharp.Formatting (and the duplicated template and styling will then likely be removed from this repo since it's no longer needed). If the design diverges to be a completely different look and feel then we can make several templates available in FSharp.Formatting with this as one of them.

The design absolutely needs improvement. By all means throw the whole current design away and author a new template from scratch.

But once improved, let's make it available as a default in FSharp.Formatting for others to use too. I think that's a key step - make this site excellent, and then make it the a default choice for everyone.

@dsyme
Copy link
Contributor

dsyme commented Aug 5, 2020

Logo link adjusted, and contribution notes added

@dsyme dsyme closed this as completed Aug 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants