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

Update schema & extensions page #109

Merged
merged 3 commits into from
Mar 13, 2024
Merged

Conversation

EliLawrence
Copy link
Contributor

  • moved the what's an ID section higher on the page
  • edited text describing the different extensions to try to make it more concise
  • clarified guidelines for measurement ID fields and updated some relevant links
  • shortened the table for eMoF terms so only most relevant shown
  • removed the tables for Event & Occurrence terms

* moved the what's an ID section higher on the page
* edited text describing the different extensions to try to make it more concise
* clarified guidelines for measurement ID fields and updated some relevant links
* shortened the table for eMoF terms so only most relevant shown
* removed the tables for Event & Occurrence terms

> ## Tip
> You can search for `measurementType` that other OBIS data providers have used by using the [OBIS mof report](https://mof.obis.org/). BE CAREFUL though to make sure the
> definition in the URI matches exactly your measurement type before you reuse it for your data.
> You can search for `measurementTypes` that other OBIS data providers have used by using the [OBIS mof report](https://mof.obis.org/). BE CAREFUL though to make sure the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am probably in the pedantic minority here but I would format this like measurementTypes

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe

You can search for a measurementType that other OBIS data providers....

@MathewBiddle
Copy link
Contributor

The changes look good. I want to build this locally before we merge to make sure the MD -> Jekyll works as expected.

@MathewBiddle
Copy link
Contributor

MathewBiddle commented Mar 11, 2024

Everything build and functions as expected. Thanks @EliLawrence!

I'm curious about the removal of the event and occurrence core table dropdowns. I'm curious about your thought process on removing those tables. Is it because some of that material is presented in the introduction?

Here is the section on the current page:
image

Here is the changed page:
image

I think I liked having all of them for reference in that page, but it does make the page much bigger.

Copy link
Contributor

@jdpye jdpye left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes look good to me, I'm glad Mat's building these locally though, that's the piece i'm missing at the moment for evaluating whether these look good in the site. I'm using the rich diffs to approximate the markdown as a temporary measure.

@EliLawrence
Copy link
Contributor Author

@MathewBiddle someone on the team suggested to remove those tables from the page because they are listed earlier, but I think having them all together on one page for quick review isn't a bad idea. Can we reject the removal of the tables but keep the others?

@MathewBiddle
Copy link
Contributor

Can we reject the removal of the tables but keep the others?

Let me try something...

@MathewBiddle
Copy link
Contributor

I think I did it:

image

I used pycharm to compare your PR with the gh-pages branch then used the accept feature to merge back in the original tables
image
very convoluted and probably more clear to just copy and paste from the source. But, I learned something today 🤷

Copy link
Contributor

@MathewBiddle MathewBiddle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good. Thanks @EliLawrence

@MathewBiddle
Copy link
Contributor

Merging. Take a look in ~5 minutes to see the changes on the website.

@MathewBiddle MathewBiddle merged commit c7fd193 into gh-pages Mar 13, 2024
2 checks passed
@MathewBiddle MathewBiddle deleted the EliLawrence-emof-2024 branch March 13, 2024 15:31
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

Successfully merging this pull request may close these issues.

4 participants