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.

Sign up for GitHub

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

Jump to bottom

The links in the contributor guide not working #92

Closed
soma2000-lang opened this issue Apr 21, 2022 · 4 comments
Closed

The links in the contributor guide not working #92

soma2000-lang opened this issue Apr 21, 2022 · 4 comments

Comments

@soma2000-lang
Copy link
Contributor

soma2000-lang commented Apr 21, 2022 •
edited
Loading

The code structure link in the current documentation is not working.
In this page
@soma2000-lang soma2000-lang mentioned this issue Apr 21, 2022
Closed
@asmitbm
Copy link
Contributor

asmitbm commented Apr 22, 2022 •
edited
Loading

It is working for me on the website: https://weaviate.io/developers/contributor-guide/current/weaviate-module-system/how-to-build-a-new-module.html

Scroll down to this line and click on the link.

@soma2000-lang
Copy link
Contributor Author

soma2000-lang commented Apr 22, 2022 •
edited
Loading

Yes on the website it's working but here{https://github.com/semi-technologies/weaviate-io/blob/main/developers/contributor-guide/current/weaviate-module-system/how-to-build-a-new-module.md} ie on the github page it is not

@asmitbm
Copy link
Contributor

asmitbm commented Apr 23, 2022 •
edited
Loading

Yes on the website it's working but here{https://github.com/semi-technologies/weaviate-io/blob/main/developers/contributor-guide/current/weaviate-module-system/how-to-build-a-new-module.md} ie on the github page it is not

The site is made with Jekyll. It is a Static Site Generator (SSG). In short, what it does is, it generates HTML output from the .MD files. So, if you change any link in the .MD file, that link will be generated in HTML output, which will redirect it to wrong place. Hence, the link properly works on the site for now, because it is linked with the right page internally.

If you want to fix links, you should go through file structure first, and see where the file is located and then link that file in the .MD file like this (./folder-name/filename)

Let me know if you face any problem, I'll be happy to help you :)

@laura-ham
Copy link
Contributor

Thanks @asmit2952 for the explanation for @soma2000-lang, I hope this clarifies! I'll close this issue :)

@laura-ham laura-ham mentioned this issue Apr 25, 2022
Closed
etiennedi pushed a commit that referenced this issue Jan 18, 2023
@bobvanluijt @etiennedi
# This is a combination of 97 commits.
d39663b 
# This is the 1st commit message:

general updates

# This is the commit message #2:

minor updates

# This is the commit message #3:

add build no to js

# This is the commit message #4:

minor change

# This is the commit message #5:

minor change

# This is the commit message #6:

minor change

# This is the commit message #7:

Update integrations.yml
# This is the commit message #8:

Jina updates

# This is the commit message #9:

Jina updates

# This is the commit message #10:

General updates regarding Haystack
# This is the commit message #11:

Update integrations.yml
# This is the commit message #12:

Update layout-documentation.html
# This is the commit message #13:

Update layout-documentation.html
# This is the commit message #14:

Tweaked some grammar
# This is the commit message #15:

Tweaked some grammar
# This is the commit message #16:

created new webpage for google summer of code

# This is the commit message #17:

update gsoc page

# This is the commit message #18:

Tweaked some reading/writing flow
# This is the commit message #19:

Tweaked some grammar, reading/writing flow
# This is the commit message #20:

Tweaked some grammar and writing/reading flow
# This is the commit message #21:

Tweaked typos and writing flow
# This is the commit message #22:

Fixed some typos, grammar, writing flow

Note: I left a placeholder for the Horizontal Scaling issue as I was unsure how that should be described now that it exists.
# This is the commit message #23:

Added a missing word and tweaked grammar
# This is the commit message #24:

Fixed typo and workflow suggestion
# This is the commit message #25:

Tweaked some typos and grammar
# This is the commit message #26:

Tweaked some typos, grammar, and writing flow.
# This is the commit message #27:

Tweaked some writing flow...
# This is the commit message #28:

Tweaked some typos
# This is the commit message #29:

Tweaked some typos
# This is the commit message #30:

Tweaked some writing style and grammar
# This is the commit message #31:

Tweaked some grammar
# This is the commit message #32:

Tweak grammar
# This is the commit message #33:

add funding news

# This is the commit message #34:

add funding news Yahoo

# This is the commit message #35:

minor updates

# This is the commit message #36:

minor updates

# This is the commit message #37:

Update java code documentary
# This is the commit message #38:

Tweaked the reading flow and grammar
# This is the commit message #39:

Tweaked grammar
# This is the commit message #40:

Fixed some grammar
# This is the commit message #41:

Tweaked language flow
# This is the commit message #42:

Tweaked some grammar
# This is the commit message #43:

Placeholder for needed fix

I was unable to find the body of text represented by the link to the docker-compose.yml configuration--> {% include docs-config-gen.html %} . A word in the instructions needs to be corrected which I included in parentheses.

...You can also select an older version for compatbility (compatibility) sake...
# This is the commit message #44:

Smoothed out the readability and fixed some grammar
# This is the commit message #45:

Fixed an upper/lower case issue.
# This is the commit message #46:

Smoothed out some language
# This is the commit message #47:

Fixed some readability issues
# This is the commit message #48:

Tweaked grammar
# This is the commit message #49:

Tweaked grammar
# This is the commit message #50:

Tweaked grammar and readability
# This is the commit message #51:

Fixed some typos

Note: I don't know the status of these pages but the images run off the right side of the page (only 25-50% are visible at 100% webpage view) and are not optimized.
# This is the commit message #52:

fix travis

# This is the commit message #53:

minor update in resources

# This is the commit message #54:

Update to Example Code--> Python.

Added required option `answer` inside `_additional`
# This is the commit message #55:

minor update in resources

# This is the commit message #56:

gh-42: update GSOC page

# This is the commit message #57:

gh-42: update GSOC page

# This is the commit message #58:

add Plausible

# This is the commit message #59:

minor updates

# This is the commit message #60:

add next pod

# This is the commit message #61:

updated podcast images

# This is the commit message #62:

minor fixes

# This is the commit message #63:

Update using multiple vectorization modules
# This is the commit message #64:

deleted old jpgs'

# This is the commit message #65:

podcast 9 img uploaded

# This is the commit message #66:

changed file size image, its now 140kb

# This is the commit message #67:

added podcast 9
# This is the commit message #68:

upload Karen Beckers company img for podcast 9
# This is the commit message #69:

Update podcasts.yml
# This is the commit message #70:

add tutorial on writing great bug reports

# This is the commit message #71:

bug report: tweak language, fix misspelling
# This is the commit message #72:

change order of new tutorial page

# This is the commit message #73:

GSoC updates

# This is the commit message #74:

created og-documentaion jpgs

# This is the commit message #75:

changed OG references

# This is the commit message #76:

changed OG references for images

# This is the commit message #77:

changed jpg size to 1200 x 630

# This is the commit message #78:

also added OGs for index pages

# This is the commit message #79:

minor OG updates

# This is the commit message #80:

Tweaked grammar, added a word for clarity
# This is the commit message #81:

Tweaked grammar
# This is the commit message #82:

Tweaked grammar
# This is the commit message #83:

Tweaked some grammar
# This is the commit message #84:

Tweaked some grammar
# This is the commit message #85:

add venturebeat

# This is the commit message #86:

add news

# This is the commit message #87:

update gql addtional props ref with timestamps, fix code sample

# This is the commit message #88:

add Slack to gsoc

# This is the commit message #89:

corrected wrong img names

# This is the commit message #90:

corrected typo in huggingface
# This is the commit message #91:

Created README.md

@bobvanluijt I added this with the information I needed when running the website locally.
# This is the commit message #92:

Update README.md
# This is the commit message #93:

Delete README.md
# This is the commit message #94:

add Yury pod

# This is the commit message #95:

make v1.11.0 the default weaviate version

# This is the commit message #96:

document how to set open AI key at runtime

# This is the commit message #97:

feat: og image generation script & refactored og image naming
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Added the correct code structure link
3 participants
@laura-ham @soma2000-lang @asmitbm