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

Change order of codelists in Reference #1405

Open
JachymHercher opened this issue Aug 29, 2021 · 5 comments · May be fixed by #1718
Open

Change order of codelists in Reference #1405

JachymHercher opened this issue Aug 29, 2021 · 5 comments · May be fixed by #1718
Labels
Focus - Documentation Includes corrections, clarifications, new guidance, and UI/UX issues
Milestone

Comments

@JachymHercher
Copy link
Contributor

When going through OCDS, I often go directly to one of the codelists in https://standard.open-contracting.org/latest/en/schema/codelists/, but then I am unsure whether it is open or closed, so I scroll up or down to find which section it is in. This seems a bit clumsy.

  1. Wouldn't it be better if each codelist has an [open] or [closed] attribute below/after it's title?
  2. If we added such an attribute, we could also remove the open / closed subsections. I'm not sure how useful they are (do people want to read about "all closed codelists" in one go? Seareching for codelists probably happens via ctrl-f.) and we could then have the same sorting across the whole page (see below).
  3. I'm not sure how the codelists are sorted. Doesn't seem to be alphabetical, by importance, nor chronological? I would go by importance/chronology.

(This issue is about ordering codelists as whole, #1198 is about ordering codes within codelists.)

@JachymHercher JachymHercher added the Focus - Documentation Includes corrections, clarifications, new guidance, and UI/UX issues label Aug 29, 2021
@JachymHercher JachymHercher changed the title Change order of codelists Change order of codelists in Reference Aug 29, 2021
@jpmckinney jpmckinney added this to the 1.2.0 milestone Sep 2, 2021
@jpmckinney
Copy link
Member

jpmckinney commented Sep 2, 2021

To avoid merge conflicts, and since the reference section for 1.1 is frozen, I've moved this to 1.2.

In #1075 I suggest one page per codelist, because some codelists are extremely long (like currency).

In that case, we will definitely need a way to indicate open/closed in an easily recognizable way.

To make it easier to find a known codelist, we can sort the codelists alphabetically in the navigation.

On the landing page for all the codelists (e.g. /schema/codelists/), we can instead logically group and order the links to the individual codelist pages (e.g. a Status section with Tender status, Award status, Contract status, Milestone status, in that order). This grouping would be easier for people who are discovering or learning about the standard.

@duncandewhurst
Copy link
Contributor

@jpmckinney your suggestions sound good to me. I think that @odscjen or I can progress with this issue as follows:

  1. Move codelists to individual pages
  2. Add a badge below each codelist page title to indicate whether the codelist is open or closed. The badges can link to the sections of the codelist landing page that explain open and closed codelists.
  3. Order the codelist pages alphabetically in the navigation
  4. Propose a grouping and ordering for the links from the codelist landing page to the individual codelist pages

Are you happy for one of us to do that?

@jpmckinney
Copy link
Member

Yes, but please check all open PRs to review whether any touch the same pages. If there are any, you can report your findings here and we can decide how to proceed.

@duncandewhurst
Copy link
Contributor

The only PR that touches codelists.md is #1660. It makes one non-whitespace change.

However, links to codelist documentation will need to be updated, e.g. ../../schema/codelists.md#party-scale will change to ../../schema/codelists/party_scale. I think that will cause conflicts with the following changes:

#1660:

#1680:

Shall we prepare the PR without updating links and leave it as a draft until at least #1680 is merged?

@jpmckinney
Copy link
Member

You can start on the PR, without updating links :)

@odscjen odscjen linked a pull request Nov 18, 2024 that will close this issue
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Focus - Documentation Includes corrections, clarifications, new guidance, and UI/UX issues
Projects
Status: To do: Reference
Development

Successfully merging a pull request may close this issue.

3 participants