Skip to content

Improve readme#247

Closed
aasaru wants to merge 9 commits into
apache:masterfrom
aasaru:improve-readme
Closed

Improve readme#247
aasaru wants to merge 9 commits into
apache:masterfrom
aasaru:improve-readme

Conversation

@aasaru
Copy link
Copy Markdown
Member

@aasaru aasaru commented Sep 21, 2020

  • move sections (publishing website, releasing) that are only relevant to few community members to the end of the readme
  • fix broken link in table of contents
  • turn different configuration list items into links to respective sections
  • remove separate chapters "Handling attachment indexing" and include the same info into respective place in documentation (to avoid information being repeated in several places)

…y relevant to few community members to the end of the readme
…d include the same info into respective place in documentation (to avoid information being repeated in several places)
Copy link
Copy Markdown
Contributor

@chibenwa chibenwa left a comment

Choose a reason for hiding this comment

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

Great to have a little lifting on the README!

Thanks for taking some your time doing it.

I think we could be taking this further by moving section of little interest into /docs folder (upcoming antora documentation) and linking to it.

Cheers,

Benoit

Comment thread README.adoc Outdated
Comment thread README.adoc Outdated
Comment thread README.adoc Outdated
Copy link
Copy Markdown
Contributor

@Arsnael Arsnael left a comment

Choose a reason for hiding this comment

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

Big thanks on this, it is greatly appreciated :)

@chibenwa
Copy link
Copy Markdown
Contributor

Cool! Can we make sure your new pages are references within docs/modules/community/nav.adoc ?

(Given that, I agree with the PR too)

Copy link
Copy Markdown
Contributor

@chibenwa chibenwa left a comment

Choose a reason for hiding this comment

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

Nice !

@chibenwa
Copy link
Copy Markdown
Contributor

Hi,

This pull request has just been merged.

Thank you again for your dedication toward the James project. If you need help, want to contribute documentation, new features, tests or bugfix, please don't hesitate to reach us.

One very last thing: I don't have write access to this repository, hence I can not close this issue. Wouldn't you mind doing it for me? It would avoid me annoying the Apache INFRA team with such simple concerns.

Thanks again,

Cheers,

Benoit

@aasaru aasaru closed this Sep 29, 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

Successfully merging this pull request may close these issues.

3 participants