You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@subversion.apache.org by Daniel Shahaf <d....@daniel.shahaf.name> on 2019/11/17 13:59:39 UTC
Re: svn commit: r1869945 - /subversion/site/staging/docs/release-notes/1.14.html
danielsh@apache.org wrote on Sun, 17 Nov 2019 13:53 +00:00:
> +++ subversion/site/staging/docs/release-notes/1.14.html Sun Nov 17 13:53:41 2019
> @@ -269,8 +269,8 @@ Welcome</a> below.</p>
> -<div class="notice">
> -<p><strong>Python is Optional.</strong></p>
> +<div class="notice" id="python-is-optional">
> +<p><strong>Python is Optional.</strong> <a class="sectionlink"
> href="#python-is-optional">¶</a></p>
So, the link works, but when clicking it, the yellow background is
replaced with dark grey, due to the usual logic for links to anchors[1].
Should we consider this a bug or a feature?
Personally, I find box easier to read when it isn't wearing a high-
visibility jacket, so to speak.
Cheers,
Daniel
[1] This:
.
#site-content :target {
background-color: #e8e8e8;
}
Re: svn commit: r1869945 - /subversion/site/staging/docs/release-notes/1.14.html
Posted by Daniel Shahaf <d....@daniel.shahaf.name>.
Nathan Hartman wrote on Mon, 18 Nov 2019 15:46 +00:00:
> The only problem with this idea is that the link won't take the reader
> directly to the information about Python. INSTALL contains a lot of
> other information to wade through.
https://svn.apache.org/viewvc/subversion/tags/1.13.0/INSTALL?revision=1868915&view=markup#l142
> Also, INSTALL is aimed at people building or packaging Subversion
> whereas the release notes are for everyone, including users who just
> want to know what's new in the latest version.
That's true, but it's not an argument against including by reference
a specific paragraph of INSTALL into the release notes.
> My original purpose in mentioning that Python is optional was to help
> avoid confusion. We can't assume that whoever reads the release notes
> knows that Subversion isn't implemented in Python and that this change
> only affects certain use cases.
+1
> I'd rather leave the information in the release notes, but put it in a
> normal section and leave just a short sentence in a yellow note box.
>
> Does that make sense?
Yes. Feel free to implement the change in whatever way you think best;
it's your call.
Cheers,
Daniel
Re: svn commit: r1869945 - /subversion/site/staging/docs/release-notes/1.14.html
Posted by Nathan Hartman <ha...@gmail.com>.
On Mon, Nov 18, 2019 at 10:16 AM Daniel Shahaf <d....@daniel.shahaf.name>
wrote:
> Nathan Hartman wrote on Sun, 17 Nov 2019 15:37 +00:00:
> > In that case, here's a thought: We can put a short message in a yellow
> > box: "Python is optional. Read more below." That would link to a
> > regular h3 section with the detailed text...
>
> +1
>
> Furthermore, we have the option of making the box link to the INSTALL
> file directly so we don't have to maintain the same information in
> two places.
>
The only problem with this idea is that the link won't take the reader
directly to the information about Python. INSTALL contains a lot of
other information to wade through. Also, INSTALL is aimed at people
building or packaging Subversion whereas the release notes are for
everyone, including users who just want to know what's new in the
latest version.
My original purpose in mentioning that Python is optional was to help
avoid confusion. We can't assume that whoever reads the release notes
knows that Subversion isn't implemented in Python and that this change
only affects certain use cases.
I'd rather leave the information in the release notes, but put it in a
normal section and leave just a short sentence in a yellow note box.
Does that make sense?
Nathan
Re: svn commit: r1869945 - /subversion/site/staging/docs/release-notes/1.14.html
Posted by Daniel Shahaf <d....@daniel.shahaf.name>.
Nathan Hartman wrote on Sun, 17 Nov 2019 15:37 +00:00:
> In that case, here's a thought: We can put a short message in a yellow
> box: "Python is optional. Read more below." That would link to a
> regular h3 section with the detailed text...
+1
Furthermore, we have the option of making the box link to the INSTALL
file directly so we don't have to maintain the same information in
two places.
Re: svn commit: r1869945 - /subversion/site/staging/docs/release-notes/1.14.html
Posted by Nathan Hartman <ha...@gmail.com>.
On Sun, Nov 17, 2019 at 9:00 AM Daniel Shahaf <d....@daniel.shahaf.name>
wrote:
> danielsh@apache.org wrote on Sun, 17 Nov 2019 13:53 +00:00:
> > +++ subversion/site/staging/docs/release-notes/1.14.html Sun Nov 17
> 13:53:41 2019
> > @@ -269,8 +269,8 @@ Welcome</a> below.</p>
> > -<div class="notice">
> > -<p><strong>Python is Optional.</strong></p>
> > +<div class="notice" id="python-is-optional">
> > +<p><strong>Python is Optional.</strong> <a class="sectionlink"
> > href="#python-is-optional">¶</a></p>
>
> So, the link works, but when clicking it, the yellow background is
> replaced with dark grey, due to the usual logic for links to anchors[1].
> Should we consider this a bug or a feature?
>
> Personally, I find box easier to read when it isn't wearing a high-
> visibility jacket, so to speak.
In that case, here's a thought: We can put a short message in a yellow box:
"Python is optional. Read more below." That would link to a regular h3
section with the detailed text...