adding changelog info, again#5
Conversation
* standardized tags/indetentation because some broken tags were hard to find * removed some "preferred" text and replaced with "required", in line with mike's latest direction
zzzeek
left a comment
zzzeek
left a comment
There was a problem hiding this comment.
that's the only content that changed, the rest is formatting right?
we don't have an example .rst file now unless they look at the other ones that are there. I usually don't attempt to get outside contributors to bother as it's too much to ask for one-time folks. but if someone wants to help more consistently it is very handy that they do these.
| </li> | ||
| <li>The file format for a changelog file uses the `.rst` markup described at | ||
| <a href="https://github.com/sqlalchemyorg/changelog">sqlalchemyorg/changelog</a>. | ||
| See the `README.txt` file in the `/doc/build/unreleased_XX` directory |
There was a problem hiding this comment.
doc/build/changelog/unreleased_XX/README.txt is the path
however README.txt doesn't have an example right now
There was a problem hiding this comment.
This section now links to #pr-requires-issue above
I started working on the example; it's in the other repo though so can't be part of this commit.
There was a problem hiding this comment.
ok can you push out the fix to that path i can merge and publish
There was a problem hiding this comment.
@zzzeek a few questions.
I am making an actual unreleased_XX/README.txt folder/file for the example in the sqlalchemy repo. I can redo that for something here.
That file has two sections. The first is a basically the existing README.txt from versioned. The second section is a quick example and overview.
I noticed the .rst files tend to use :tickets: but the https://github.com/sqlalchemyorg/changelog/blob/master/README.rst notes :ticket:
Looking at the code, it seems most of the per-ticket items .rst files use :tickets: but the generated files typically use :ticket:
Are these interchangable? Am I overthinking this?
There was a problem hiding this comment.
it's supposed to be :tickets: because there can be mutiple present there.
There's a README.txt already present, we can add to that? https://github.com/sqlalchemy/sqlalchemy/blob/master/doc/build/changelog/unreleased_13/README.txt the unreleased_XX folder is there too already?
There was a problem hiding this comment.
I added a new unreleased_xx folder, and used the README from the 1.x branches as the starting point. I was thinking about updating the existing README files to reference that one
There was a problem hiding this comment.
we can call it unreleased_XX here but it means to look in each numbered folder
|
looks good to me |
|
updated SqlAlchemy > SQLAlchemy |
3 participants
abandoning #2 in favor of this